Skip to main content
interface ExecuteSqlRequest
data?: string[];
encoding?: string;
limit?: number;
offset?: number;
options?: Record<string, string>;
request_schema_str?: string;
statement: string;
data? encoding? limit? offset? options? request_schema_str? statement
data?: string[]

An array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format.

encoding?: string

Specifies the encoding for returned records; either ‘binary’ or ‘json’.

limit?: number

A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server’s own limit, defined by the max_get_records_size parameter in the server configuration. Use has_more_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results.

offset?: number

A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).

options?: Record<string, string>

Optional parameters.

request_schema_str?: string

Avro schema of data.

statement: string

SQL statement (query, DML, or DDL) to be executed.