get_records_by_column
- get_records_by_column(
table_name: string,
column_names: string[],
offset?: number,
limit?: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<GetRecordsByColumnResponse>Parameters
- 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.
- column_names: string[]
The list of column values to retrieve.
Optionaloffset: numberA positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
Optionallimit: numberA 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_recordsto see if more records exist in the result to be fetched, andoffsetandlimitto request subsequent pages of results.Optionaloptions: Record<string, string>Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<GetRecordsByColumnResponse>
Promise<Types.GetRecordsByColumnResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:10213
- table_name: string
get_records_by_column_request
- get_records_by_column_request(
request: GetRecordsByColumnRequest,
callback?: GPUdbCallback,
): Promise<GetRecordsByColumnResponse>For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the
offsetandlimitparameters.Window functions, which can perform operations like moving averages, are available through this endpoint as well as
create_projection.When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If
table_nameis empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
Parameters
- request: GetRecordsByColumnRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<GetRecordsByColumnResponse>
Promise<Types.GetRecordsByColumnResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:10152
- request: GetRecordsByColumnRequest
For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the
offsetandlimitparameters.Window functions, which can perform operations like moving averages, are available through this endpoint as well as
create_projection.When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
If
table_nameis empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).The response is returned as a dynamic schema. For details see: dynamic schemas documentation.