get_records
- get_records(
table_name: string,
offset?: number,
limit?: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<GetRecordsResponse>Parameters
- table_name: string
Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
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<GetRecordsResponse>
Promise<Types.GetRecordsResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:10100
- table_name: string
get_records_request
- get_records_request(
request: GetRecordsRequest,
callback?: GPUdbCallback,
): Promise<GetRecordsResponse>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.
This operation supports paging through the data via the
offsetandlimitparameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.Parameters
- request: GetRecordsRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<GetRecordsResponse>
Promise<Types.GetRecordsResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:10052
- request: GetRecordsRequest
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.
This operation supports paging through the data via the
offsetandlimitparameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.