Wrangler commands

Note

Pipelines is currently in open beta. Report Pipelines bugs in GitHub ↗.

create

Create a new pipeline

wrangler pipelines create <PIPELINE_NAME> [OPTIONS]

• PIPELINE_NAME string required
  • The name of the pipeline to create.
• --sql string optional
  • Inline SQL query for the pipeline. Refer to SQL reference.
• --sql-file string optional
  • Path to file containing SQL query for the pipeline. Refer to SQL reference.

delete

Delete a pipeline

wrangler pipelines delete <PIPELINE_ID> [OPTIONS]

• PIPELINE_ID string required
  • The ID of the pipeline to delete.
• --force boolean optional
  • Skip confirmation.

get

Get details about a specific pipeline

wrangler pipelines get <PIPELINE_ID> [OPTIONS]

• PIPELINE_ID string required
  • The ID of the pipeline to retrieve.
• --json boolean optional
  • Output in JSON format.

list

List all pipelines

wrangler pipelines list [OPTIONS]

• --page number optional
  • Page number for pagination.
• --per-page number optional
  • Number of pipelines per page.
• --json boolean optional
  • Output in JSON format.

setup

Interactive setup for a complete pipeline

wrangler pipelines setup [OPTIONS]

• --name string optional
  • Pipeline name.

streams create

Create a new stream

wrangler pipelines streams create <STREAM_NAME> [OPTIONS]

• STREAM_NAME string required
  • The name of the stream to create.
• --schema-file string optional
  • Path to JSON file containing stream schema. Refer to schema configuration.
• --http-enabled boolean optional
  • Enable HTTP endpoint. Defaults to true.
• --http-auth boolean optional
  • Require authentication for HTTP endpoint. Defaults to true.
• --cors-origin array optional
  • CORS origin.

streams delete

Delete a stream

wrangler pipelines streams delete <STREAM_ID> [OPTIONS]

• STREAM_ID string required
  • The ID of the stream to delete.
• --force boolean optional
  • Skip confirmation.

streams get

Get details about a specific stream

wrangler pipelines streams get <STREAM_ID> [OPTIONS]

• STREAM_ID string required
  • The ID of the stream to retrieve.
• --json boolean optional
  • Output in JSON format.

streams list

List all streams

wrangler pipelines streams list [OPTIONS]

• --page number optional
  • Page number for pagination
• --per-page number optional
  • Number of streams per page.
• --pipeline-id string optional
  • Filter streams by pipeline ID.
• --json boolean optional
  • Output in JSON format

sinks create

Create a new sink

wrangler pipelines sinks create <SINK_NAME> [OPTIONS]

• SINK_NAME string required
  • The name of the sink to create.
• --type string required
  • The type of sink to create. Choices: r2, r2-data-catalog.
• --bucket string required
  • R2 bucket name.
• --format string optional
  • Output format. Choices: json, parquet.
• --compression string optional
  • Compression method (parquet only). Choices: uncompressed, snappy, gzip, zstd, lz4.
• --target-row-group-size string optional
  • Target row group size for parquet format (parquet only).
• --path string optional
  • The base prefix in your bucket where data will be written (r2 sinks only).
• --partitioning string optional
  • Time partition pattern (r2 sinks only).
• --roll-size number optional
  • Roll file size in MB.
• --roll-interval number optional
  • Roll file interval in seconds.
• --access-key-id string optional
  • R2 access key ID (required for r2 sinks). Refer to R2 sink authentication.
• --secret-access-key string optional
  • R2 secret access key (required for r2 sinks). Refer to R2 sink authentication.
• --namespace string optional
  • Data catalog namespace (required for r2-data-catalog).
• --table string optional
  • Table name within namespace (required for r2-data-catalog).
• --catalog-token string optional
  • Authentication token for data catalog (required for r2-data-catalog sinks). Refer to R2 Data Catalog authentication.

sinks delete

Delete a sink

wrangler pipelines sinks delete <SINK_ID> [OPTIONS]

• SINK_ID string required
  • The ID of the sink to delete.
• --force boolean optional
  • Skip confirmation.

sinks get

Get details about a specific sink

wrangler pipelines sinks get <SINK_ID> [OPTIONS]

• SINK_ID string required
  • The ID of the sink to retrieve.
• --json boolean optional
  • Output in JSON format.

sinks list

List all sinks

wrangler pipelines sinks list [OPTIONS]

• --page number optional
  • Page number for pagination
• --per-page number optional
  • Number of sinks per page.
• --pipeline-id string optional
  • Filter sinks by pipeline ID.
• --json boolean optional
  • Output in JSON format

Global commands

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.