Skip to main content
Source

​
pub async fn get_records_by_column( &self, table_name: String, column_names: Vec<String>, offset: i64, limit: i64, ) -> Result<GetRecordsByColumnResponse, KineticaError>

Retrieve the values of the given columns within a specified range.

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

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_name is 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.

  • table_name - 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 - The list of column values to retrieve.
  • 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_by_column_with_opts( &self, table_name: String, column_names: Vec<String>, offset: i64, limit: i64, options: GetRecordsByColumnRequestOptions, ) -> Result<GetRecordsByColumnResponse, KineticaError>

Retrieve the values of the given columns within a specified range.

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

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_name is 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.

  • table_name - 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 - The list of column values to retrieve.
  • 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 GetRecordsByColumnRequest to the /get/records/bycolumn endpoint and decodes the records it returns. Only binary encoding is supported.

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

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