Sign in
Output Connectors

Subscribe to View

Required role: write or higher.

Subscribe to a stream of updates from a SQL view or table.

The pipeline responds with a continuous stream of changes to the specified table or view. The stream is configurable two ways:

  • Simple configuration of the format may be provided using query parameters. Specify backpressure to specify behavior when the HTTP client cannot keep up. Use format to specify csv or json output. For json output format, update_format and json_flavor may be provided (with the same possible values as in JSON format configuration for connectors).

  • Comprehensive configuration may be provided by providing a connector configuration as a JSON body. In this case, no query parameters are allowed.

Updates are split into Chunks.

The pipeline continues sending updates until the client closes the connection or the pipeline is stopped.

post/v0/pipelines/{pipeline_name}/egress/{table_name}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_namestring required

Unique pipeline name

table_namestring required

SQL table name. Unquoted SQL names have to be capitalized. Quoted SQL names have to exactly match the case from the SQL program.

Query parameters

formatstring required

Output data format, either 'csv' or 'json'.

send_snapshotboolean nullable

Set to true to send a full snapshot of a materialized view before streaming incremental updates. The default is false. Works on a paused pipeline: the snapshot is delivered from the latest cached view state without requiring the pipeline to be running.

arrayboolean nullable

Set to true to group updates in this stream into JSON arrays (used in conjunction with format=json). The default value is false

backpressureboolean nullable

Apply backpressure on the pipeline when the HTTP client cannot receive data fast enough. When this flag is set to false (the default), the HTTP connector drops data chunks if the client is not keeping up with its output. This prevents a slow HTTP client from slowing down the entire pipeline. When the flag is set to true, the connector waits for the client to receive each chunk and blocks the pipeline if the client cannot keep up.

Response

Connection to the endpoint successfully established. The body of the response contains a stream of data chunks.

bin_datastring binary nullable

Base64 encoded binary payload, e.g., bincode.

json_dataobject nullable

JSON payload.

sequence_numberinteger required
snapshotboolean required

true when this chunk is part of the initial snapshot delivered in send_snapshot mode; false for incremental delta updates.

text_datastring nullable

Text payload, e.g., CSV.

Changes

No recorded changes to this operation across all 51 revisions of this API.