/get/records/fromcollection

URL: http://<db.host>:<db.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 views using this operation. (DEPRECATED)

Input Parameter Description

NameTypeDescription
table_namestringName of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
offsetlongA 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.
limitlongA 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 input parameter offset & input parameter limit to request subsequent pages of results. The default value is -9999.
encodingstring

Specifies the encoding for returned records; either binary or json. The default value is binary. The supported values are:

  • binary
  • json
optionsmap 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. The default value is false. The supported values are:

  • true
  • false
expressionOptional filter expression to apply to the table. The default value is ''.

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'get_records_from_collection_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
table_namestringValue of input parameter table_name.
type_namesarray of stringsThe 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_binaryarray of bytesIf 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_jsonarray of stringsIf 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_idsarray of stringsIf 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.
infomap of string to strings

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

Possible Parameters (keys)Parameter Description
total_number_of_recordsTotal number of records.
has_more_records

Too many records. Returned a partial set. Possible values are:

  • true
  • false

Empty string in case of an error.