Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs.feldera.com/docs/connectors/completion-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ CREATE TABLE price (
### Step 1. Push data via HTTP

```shell
curl -s -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply-chain/ingress/PRICE?format=json -d '
curl -s -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply-chain/ingress/PRICE?format=json' -d '
{"insert": {"part": 1, "vendor": 2, "price": 10000}}
{"insert": {"part": 2, "vendor": 1, "price": 15000}}
{"insert": {"part": 3, "vendor": 3, "price": 9000}}'| jq
Expand All @@ -115,7 +115,7 @@ CREATE TABLE price (
Let us generate another completion token for the URL input connector attached to the table.

```shell
curl -s -X 'GET' http://127.0.0.1:8080/v0/pipelines/supply-chain/tables/PRICE/connectors/tutorial-price-s3/completion_token | jq
curl -s -X 'GET' 'http://127.0.0.1:8080/v0/pipelines/supply-chain/tables/PRICE/connectors/tutorial-price-s3/completion_token' | jq
```

> Note that this endpoint requires the user to explicitly assign a name to the connector (`"name": "tutorial-price-s3"`)
Expand All @@ -132,7 +132,7 @@ CREATE TABLE price (
### Step 3. Check the status of both tokens

```shell
curl -s -X 'GET' http://127.0.0.1:8080/v0/pipelines/supply-chain/completion_status?token=eyJ1IjoiMDE5NmIxMjAtNjIwMy03YjkwLWI2YmQtMTY4OTBkZjE1ZTI4IiwiZSI6MywiYyI6M30= | jq
curl -s -X 'GET' 'http://127.0.0.1:8080/v0/pipelines/supply-chain/completion_status?token=eyJ1IjoiMDE5NmIxMjAtNjIwMy03YjkwLWI2YmQtMTY4OTBkZjE1ZTI4IiwiZSI6MywiYyI6M30=' | jq
```

```json
Expand All @@ -142,7 +142,7 @@ CREATE TABLE price (
```

```shell
curl -s -X 'GET' http://127.0.0.1:8080/v0/pipelines/supply-chain/completion_status?token=eyJ1IjoiMDE5NmIxMjAtNjIwMy03YjkwLWI2YmQtMTY4OTBkZjE1ZTI4IiwiZSI6MSwiYyI6M30= | jq
curl -s -X 'GET' 'http://127.0.0.1:8080/v0/pipelines/supply-chain/completion_status?token=eyJ1IjoiMDE5NmIxMjAtNjIwMy03YjkwLWI2YmQtMTY4OTBkZjE1ZTI4IiwiZSI6MSwiYyI6M30=' | jq
```

```json
Expand Down
4 changes: 2 additions & 2 deletions docs.feldera.com/docs/connectors/sinks/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ Stream incremental updates (default):

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/egress/average_price?format=json
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/egress/average_price?format=json'
```

Receive a full snapshot followed by incremental updates:

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/egress/average_price?format=json\&send_snapshot=true
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/egress/average_price?format=json&send_snapshot=true'
```

### Python (direct API calls)
Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/connectors/sources/http-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ WITH ('connectors' = '[{
### curl

```bash
curl -i -X PUT http://127.0.0.1:8080/v0/pipelines/workshop \
curl -i -X PUT 'http://127.0.0.1:8080/v0/pipelines/workshop' \
-H 'Content-Type: application/json' \
-d "$(jq -Rsn \
--rawfile code program.sql \
Expand Down
10 changes: 5 additions & 5 deletions docs.feldera.com/docs/connectors/sources/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@ We will insert rows into table `product` for pipeline `supply-chain-pipeline`.

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json \
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json' \
-d '{"insert": {"pid": 0, "name": "hammer", "price": 5.0}}'
```

#### One row while providing authorization header

```bash
curl -i -H "Authorization: Bearer <API-KEY>" -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json \
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json' \
-d '{"insert": {"pid": 0, "name": "hammer", "price": 5.0}}'
```

#### Multiple rows as newline-delimited JSON (NDJSON)

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json \
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json' \
-d '{"insert": {"pid": 0, "name": "hammer", "price": 5}}
{"insert": {"pid": 1, "name": "nail", "price": 0.02}}'
```
Expand All @@ -49,15 +49,15 @@ curl -i -X 'POST' \

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json\&array=true \
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json&array=true' \
-d '[{"insert": {"pid": 0, "name": "hammer", "price": 5}}, {"insert": {"pid": 1, "name": "nail", "price": 0.02}}]'
```

#### Delete a row

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json \
'http://127.0.0.1:8080/v0/pipelines/supply-chain-pipeline/ingress/product?format=json' \
-d '{"delete": {"pid": 1}}'
```

Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/connectors/sources/nats.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Before using the NATS input connector, you need a NATS server with JetStream ena
The quickest way to start experimenting with Feldera and NATS is to use Docker Compose:

```bash
curl -L https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml -o docker-compose.yml
curl -L 'https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml' -o docker-compose.yml
docker compose --profile nats up
```

Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/formats/raw.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Insert two records with values `hello` and `world`:

```bash
curl -i -X 'POST' \
http://127.0.0.1:8080/v0/pipelines/my_pipeline/ingress/raw_table?format=raw&mode=lines \
'http://127.0.0.1:8080/v0/pipelines/my_pipeline/ingress/raw_table?format=raw&mode=lines' \
-d 'hello
world'
```
4 changes: 2 additions & 2 deletions docs.feldera.com/docs/get-started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Feldera with auxiliary services included in the Docker Compose file
like Redpanda, Prometheus and Grafana.

```
curl -L https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml | \
curl -L 'https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml' | \
docker compose -f - up
```

You can enable specific services from the Docker Compose file as follows:

```
curl -L https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml | \
curl -L 'https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml' | \
docker compose -f - up pipeline-manager redpanda
```

Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/get-started/enterprise/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ section below describes one way to generate these files.
errors about an insecure connection (or self-signed certificates).
For example, when using curl:
```
curl --cacert tls.crt https://localhost:8080/v0/pipelines
curl --cacert tls.crt 'https://localhost:8080/v0/pipelines'
```

It is no longer possible to reach the endpoints via HTTP.
Expand Down
12 changes: 6 additions & 6 deletions docs.feldera.com/docs/interface/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ It allows you to create, manage, and monitor pipelines. It also features an inte
<TabItem value="linux" label="Linux">

```bash
curl -fsSL https://docs.feldera.com/install-fda | bash
curl -fsSL 'https://docs.feldera.com/install-fda' | bash
```

| Supported platforms |
Expand All @@ -29,7 +29,7 @@ Requires glibc >= 2.39 (Ubuntu 24.04+, Debian 13+, Fedora 40+, RHEL 10+).
<TabItem value="macos" label="macOS">

```bash
curl -fsSL https://docs.feldera.com/install-fda | bash
curl -fsSL 'https://docs.feldera.com/install-fda' | bash
```

| Supported platforms |
Expand Down Expand Up @@ -70,14 +70,14 @@ To install a specific version, pass the release git tag to the install script:
<TabItem value="linux" label="Linux">

```bash
curl -fsSL https://docs.feldera.com/install-fda | FDA_VERSION=v0.290.0 bash
curl -fsSL 'https://docs.feldera.com/install-fda' | FDA_VERSION=v0.290.0 bash
```

</TabItem>
<TabItem value="macos" label="macOS">

```bash
curl -fsSL https://docs.feldera.com/install-fda | FDA_VERSION=v0.290.0 bash
curl -fsSL 'https://docs.feldera.com/install-fda' | FDA_VERSION=v0.290.0 bash
```

</TabItem>
Expand All @@ -96,14 +96,14 @@ To install to a custom directory:
<TabItem value="linux" label="Linux">

```bash
curl -fsSL https://docs.feldera.com/install-fda | FDA_VERSION=v0.290.0 FELDERA_INSTALL=/opt/feldera bash
curl -fsSL 'https://docs.feldera.com/install-fda' | FDA_VERSION=v0.290.0 FELDERA_INSTALL=/opt/feldera bash
```

</TabItem>
<TabItem value="macos" label="macOS">

```bash
curl -fsSL https://docs.feldera.com/install-fda | FDA_VERSION=v0.290.0 FELDERA_INSTALL=/opt/feldera bash
curl -fsSL 'https://docs.feldera.com/install-fda' | FDA_VERSION=v0.290.0 FELDERA_INSTALL=/opt/feldera bash
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs.feldera.com/docs/operations/visualizing-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ This flag adds the `PERFMON` capability to the pipeline pod to enable profiling.

```bash
# Start a 60 second profiling session
curl -X POST "http://localhost:8080/v0/pipelines/my-pipeline/samply_profile?duration_secs=60"
curl -X POST 'http://localhost:8080/v0/pipelines/my-pipeline/samply_profile?duration_secs=60'
```

#### Retrieve the profile
Expand All @@ -302,7 +302,7 @@ Wait for `duration_secs` for the profiling to complete. Then make a `GET` reques
```bash

# Retrieve the profile (after the session completes)
curl "http://localhost:8080/v0/pipelines/my-pipeline/samply_profile" -o prof.json.gz
curl 'http://localhost:8080/v0/pipelines/my-pipeline/samply_profile' -o prof.json.gz
```

##### Failures
Expand Down
8 changes: 4 additions & 4 deletions docs.feldera.com/docs/pipelines/checkpoint-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ staying ready for immediate activation.
To activate a standby pipeline:

```sh
curl -X POST https://{FELDERA_HOST}/v0/pipelines/{PIPELINE_NAME}/activate
curl -X POST 'https://{FELDERA_HOST}/v0/pipelines/{PIPELINE_NAME}/activate'
```

:::important
Expand Down Expand Up @@ -217,7 +217,7 @@ Automatic sync is **disabled by default**.
The status of the most recent automatic sync operation can be queried with:

```bash
curl http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync_status | jq '.periodic'
curl 'http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync_status' | jq '.periodic'
```

It is recommended to set `push_interval` greater than
Expand All @@ -240,7 +240,7 @@ following conditions are met:
A sync operation can be triggered by making a `POST` request to:

```bash
curl -X POST http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync
curl -X POST 'http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync'
```

This initiates the sync and returns the UUID of the checkpoint being synced:
Expand All @@ -254,7 +254,7 @@ This initiates the sync and returns the UUID of the checkpoint being synced:
The status of the sync operation can be checked with:

```bash
curl http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync_status
curl 'http://localhost/v0/pipelines/{PIPELINE_NAME}/checkpoint/sync_status'
```

### Response fields
Expand Down
8 changes: 4 additions & 4 deletions docs.feldera.com/docs/pipelines/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Use the [`start_transaction`](/api/begin-transaction) API to start a transaction
<Tabs>
<TabItem value="rest" label="REST API">
```shell
$ curl -X POST http://localhost:8080/v0/pipelines/my_pipeline/start_transaction
$ curl -X POST 'http://localhost:8080/v0/pipelines/my_pipeline/start_transaction'

{"transaction_id":1}
```
Expand Down Expand Up @@ -93,7 +93,7 @@ commit the transaction using the [`commit_transaction`](/api/commit-transaction)
<Tabs>
<TabItem value="rest" label="REST API">
```shell
$ curl -X POST http://localhost:8080/v0/pipelines/my_pipeline/commit_transaction
$ curl -X POST 'http://localhost:8080/v0/pipelines/my_pipeline/commit_transaction'
"Transaction commit initiated"
```
</TabItem>
Expand Down Expand Up @@ -152,10 +152,10 @@ Transaction status is also available through [metrics](/operations/metrics.md#tr
<Tabs>
<TabItem value="rest" label="REST API">
```shell
$ curl -s http://localhost:8080/v0/pipelines/my_pipeline/stats | jq -r '.global_metrics.transaction_status'
$ curl -s 'http://localhost:8080/v0/pipelines/my_pipeline/stats' | jq -r '.global_metrics.transaction_status'
TransactionInProgress

$ curl -s http://localhost:8080/v0/pipelines/my_pipeline/stats | jq -r '.global_metrics.transaction_id'
$ curl -s 'http://localhost:8080/v0/pipelines/my_pipeline/stats' | jq -r '.global_metrics.transaction_id'
1
```
</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/sql/udf.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ base64 = \"0.22.1\"
" > udf.toml


curl -i -X PUT http://127.0.0.1:8080/v0/pipelines/udf_api_test \
curl -i -X PUT 'http://127.0.0.1:8080/v0/pipelines/udf_api_test' \
-H 'Content-Type: application/json' \
-d "$(jq -Rsn \
--rawfile sql program.sql \
Expand Down
10 changes: 5 additions & 5 deletions docs.feldera.com/docs/tutorials/basics/part2.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Start the pipeline you created in Part 1 of the tutorial from a clean state:
Subscribe to changes to the `PREFERRED_VENDOR` view:

```bash
curl -s -N -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply_chain/egress/PREFERRED_VENDOR?format=json | jq
curl -s -N -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply_chain/egress/PREFERRED_VENDOR?format=json' | jq
```

You should see periodic heartbeat messages:
Expand All @@ -52,7 +52,7 @@ In another terminal, use the following command to populate the `PART` table
with the same data we entered manually in part 1 of the tutorial:

```bash
curl -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PART?format=json -d '
curl -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PART?format=json' -d '
{"insert": {"id": 1, "name": "Flux Capacitor"}}
{"insert": {"id": 2, "name": "Warp Core"}}
{"insert": {"id": 3, "name": "Kyber Crystal"}}'
Expand All @@ -66,12 +66,12 @@ Records are encoded as JSON objects with one key per table column.
Next, we populate the other two tables:

```bash
curl -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/VENDOR?format=json -d '
curl -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/VENDOR?format=json' -d '
{"insert": {"id": 1, "name": "Gravitech Dynamics", "address": "222 Graviton Lane"}}
{"insert": {"id": 2, "name": "HyperDrive Innovations", "address": "456 Warp Way"}}
{"insert": {"id": 3, "name": "DarkMatter Devices", "address": "333 Singularity Street"}}'

curl -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PRICE?format=json -d '
curl -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PRICE?format=json' -d '
{"insert": {"part": 1, "vendor": 2, "price": 10000}}
{"insert": {"part": 2, "vendor": 1, "price": 15000}}
{"insert": {"part": 3, "vendor": 3, "price": 9000}}'
Expand Down Expand Up @@ -137,7 +137,7 @@ that there is no `update` command. Modifying a record amounts to deleting the
old version and inserting the new one.

```bash
curl -X 'POST' http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PRICE?format=json -d '
curl -X 'POST' 'http://127.0.0.1:8080/v0/pipelines/supply_chain/ingress/PRICE?format=json' -d '
{"delete": {"part": 1, "vendor": 2, "price": 10000}}
{"insert": {"part": 1, "vendor": 2, "price": 30000}}
{"delete": {"part": 2, "vendor": 1, "price": 15000}}
Expand Down
2 changes: 1 addition & 1 deletion docs.feldera.com/docs/tutorials/basics/part3.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ the Redpanda container should already be running. Otherwise, you can start it
using the following command:

```bash
curl -L https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml | docker compose -f - up redpanda
curl -L 'https://raw.githubusercontent.com/feldera/feldera/main/deploy/docker-compose.yml' | docker compose -f - up redpanda
```

Next, you will need to install `rpk`, the Redpanda CLI, by following the instructions on
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The cluster monitor events can be retrieved via two endpoints:

**Request**
```
curl -X GET http://127.0.0.1:8080/v0/cluster/events | jq
curl -X GET 'http://127.0.0.1:8080/v0/cluster/events' | jq
```

**Response**
Expand Down Expand Up @@ -62,7 +62,7 @@ curl -X GET http://127.0.0.1:8080/v0/cluster/events | jq

**Request**
```
curl -X GET http://127.0.0.1:8080/v0/cluster/events/latest | jq
curl -X GET 'http://127.0.0.1:8080/v0/cluster/events/latest' | jq
```

**Response**
Expand All @@ -81,7 +81,7 @@ curl -X GET http://127.0.0.1:8080/v0/cluster/events/latest | jq

**Request**
```
curl -X GET http://127.0.0.1:8080/v0/cluster/events/019afe45-ec1f-7de0-9cd1-3a6a4350b5e9?selector=all | jq
curl -X GET 'http://127.0.0.1:8080/v0/cluster/events/019afe45-ec1f-7de0-9cd1-3a6a4350b5e9?selector=all' | jq
```

**Response**
Expand Down
Loading