Skip to main content
interface GetRecordsByColumnRequest
column_names: string[];
encoding?: string;
limit?: number;
offset?: number;
options?: Record<string, string>;
table_name: string;
column_names encoding? limit? offset? options? table_name
column_names: string[]

The list of column values to retrieve.

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>
table_name: string

Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.