Skip to main content
Source

​
pub async fn get_records<R: RetrievedRecord>( &self, table_name: String, offset: i64, limit: i64, ) -> Result<GetRecordsResponse<R>, KineticaError>

Retrieve records from a table with optional filtering and sorting

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 offset and limit parameters. 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.

The records are decoded by the types the server names, as known to this client or else read from the server.

  • table_name - Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
  • offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
  • limit - 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.
Source

​
pub async fn get_records_with_opts<R: RetrievedRecord>( &self, table_name: String, offset: i64, limit: i64, options: GetRecordsRequestOptions, ) -> Result<GetRecordsResponse<R>, KineticaError>

Retrieve records from a table with optional filtering and sorting

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 offset and limit parameters. 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.

The records are decoded by the types the server names, as known to this client or else read from the server.

  • table_name - Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
  • offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
  • limit - 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.
  • options - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built GetRecordsRequest to the /get/records endpoint and decodes the records it returns, by record_type if given, else by the types the server names. Only binary encoding is supported.

Sends a pre-built GetRecordsRequest to the /get/records endpoint, returning the response as the server sends it.

Sends a pre-built GetRecordsRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.