Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
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 input parameter offset and input parameter 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.
Input Parameter Description
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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. | ||||||||||
offset | long | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. | ||||||||||
limit | long | 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 output parameter has_more_records to see if more records exist in the result to be fetched, and input parameter offset & input parameter limit to request subsequent pages of results. The default value is -9999. | ||||||||||
encoding | string | Specifies the encoding for returned records; one of binary, json, or geojson. The default value is binary. The supported values are:
| ||||||||||
options | map of string to strings | The default value is an empty map ( {} ).
|
Output Parameter Description
Name | Type | Description |
---|---|---|
table_name | string | Value of input parameter table_name. |
type_name | string | |
type_schema | string | Avro schema of output parameter records_binary or output parameter records_json |
records_binary | array of bytes | If the input parameter encoding was 'binary', then this list contains the binary encoded records retrieved from the table, otherwise not populated. |
records_json | array of strings | If the input parameter encoding was 'json', then this list contains the JSON encoded records retrieved from the table. If the input parameter encoding was 'geojson' this list contains a single entry consisting of a GeoJSON FeatureCollection containing a feature per record. Otherwise not populated. |
total_number_of_records | long | Total/Filtered number of records. |
has_more_records | boolean | Too many records. Returned a partial set. |
info | map of string to strings | Additional information. |