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.
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.
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 and input parameter limit to request subsequent pages of results.The default value is -9999.
Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET].The default value is true.The supported values are:
String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided.The default value is ascending.The supported values are:
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
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.
