Skip to main content

Execute an ad-hoc query in a running or paused pipeline.

Execute an ad-hoc query in a running or paused pipeline.

Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

Query Parameters
sql string REQUIRED

The SQL query to execute.

format string REQUIRED

Possible values: [text, json, parquet]

URL-encoded format argument to the /query endpoint.

Input data format, e.g., 'text', 'json' or 'parquet'.

Responses
200

Executes an ad-hoc SQL query in a running or paused pipeline. The evaluation is not incremental.

Schema OPTIONAL
string
400

Pipeline is shutdown or an invalid SQL query was supplied

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

404

Pipeline with that name does not exist

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500

A fatal error occurred during query processing (after streaming response was already initiated)

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.