Version:

/get/records/fromcollection

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/get/records/fromcollection

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as /delete/records.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Input Parameter Description

Name Type Description
table_name string Name of the collection or table from which records are to be retrieved. Must be an existing collection or table.
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 max number of results 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 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; either 'binary' or 'json'. The supported values are:

  • binary
  • json
options map of string to strings

The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
return_record_ids

If 'true' then return the internal record ID along with each returned record. Default is 'false'. The supported values are:

  • true
  • false

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_from_collection_request' 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/fromcollection endpoint:

Name Type Description
table_name string Value of input parameter table_name.
type_names array of strings The type IDs of the corresponding records in output parameter records_binary or output parameter records_json. This is useful when input parameter table_name is a heterogeneous collection (collections containing tables of different types).
records_binary array of bytes If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. Otherwise, empty list.
records_json array of strings If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection. Otherwise, empty list.
record_ids array of strings If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object. Otherwise it will be empty.
info map of string to strings Additional information.

Empty string in case of an error.