Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/get/records/byseries

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/get/records/byseries

Retrieves the complete series/track records from the given input parameter world_table_name based on the partial track information contained in the input parameter table_name.

This operation supports paging through the data via the input parameter offset and input parameter limit parameters.

In contrast to /get/records this returns records grouped by series/track. So if input parameter offset is 0 and input parameter limit is 5 this operation would return the first 5 series/tracks in input parameter table_name. Each series/track will be returned sorted by their TIMESTAMP column.

Input Parameter Description

Name	Type	Description
table_name	string	Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
world_table_name	string	Name of the table containing the complete series/track information to be returned for the tracks present in the input parameter table_name, in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offset	int	A positive integer indicating the number of initial series/tracks to skip (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	int	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
encoding	string	Specifies the encoding for returned records; either binary or json. The default value is binary. The supported values are: binary json
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'get_records_by_series_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /get/records/byseries endpoint:

Name	Type	Description
table_names	array of strings	The table name (one per series/track) of the returned series/tracks.
type_names	array of strings	The type IDs (one per series/track) of the returned series/tracks.
type_schemas	array of strings	The type schemas (one per series/track) of the returned series/tracks.
list_records_binary	array of arrays of bytes	If the encoding parameter of the request was 'binary' then this list-of-lists contains the binary encoded records for each object (inner list) in each series/track (outer list). Otherwise, empty list-of-lists.
list_records_json	array of arrays of strings	If the encoding parameter of the request was 'json' then this list-of-lists contains the json encoded records for each object (inner list) in each series/track (outer list). Otherwise, empty list-of-lists.
info	map of string to strings	Additional information.

Empty string in case of an error.