get\_records\_from\_collection(table\_name=None, offset=0, limit=-9999, encoding='binary', options={"{"}{"}"})\[source]

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb.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)

Parameters

table\_name (str) –

Name 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.

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 input parameter offset and input parameter limit to request subsequent pages of results. The default value is -9999.

encoding (str) –

Specifies the encoding for returned records; either binary or json. Allowed values are:

binary
json

The default value is ‘binary’.

options (dict of str to str) –

Allowed keys are:

return\_record\_ids – If true then return the internal record ID along with each returned record. Allowed values are:
- true
- false
The default value is ‘false’.
expression – Filter expression to apply to the table. The default value is ‘’.

The default value is an empty dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

table\_name (str) –

Value of input parameter table\_name.

type\_names (list of str) –

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 (list 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 (list of str) –

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 (list of str) –

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 (dict of str to str) –

Additional information. Allowed keys are:

total\_number\_of\_records – Total number of records.
has\_more\_records – Too many records. Returned a partial set. Allowed values are:
- true
- false

The default value is an empty dict ( {"{"}{"}"} ).

record\_types (list of RecordType) –

A list of RecordType objects using which the user can decode the binary data by using GPUdbRecord.decode\_binary\_data() per record.