Skip to main content
get_records(table_name=None, offset=0, limit=-9999, encoding=‘binary’, options=, get_record_type=True)[source]

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.

Parameters

table_name (str) –

Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

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

encoding (str) –

Specifies the encoding for returned records; one of binary, json, or geojson. Allowed values are:

  • binary

  • json

  • geojson

  • arrow

The default value is ‘binary’.

options (dict of str to str) –

Allowed keys are:

  • expression – Filter expression to apply to the table.

  • fast_index_lookup – 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]. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • sort_by – Column that the data should be sorted by. Empty by default (i.e. no sorting is applied).

  • sort_order – String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Allowed values are:

    • ascending

    • descending

    The default value is ‘ascending’.

The default value is an empty dict ( ).

get_record_type (bool) –

If True, deduce and return the record type for the returned records. Default is True.

Returns

A dict with the following entries–

table_name (str) –

Value of input parameter table_name.

type_name (str) –

The name of the type of the returned records.

type_schema (str) –

Avro schema of output parameter records_binary or output parameter records_json.

records_binary (list of bytes) –

If the input parameter encoding was ‘binary’, then this list contains the binary encoded records retrieved from the table, otherwise not populated.

records_json (list of str) –

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.

total_number_of_records (long) –

Total/Filtered number of records.

has_more_records (bool) –

Too many records. Returned a partial set.

info (dict of str to str) –

Additional information.

record_type (RecordType or None) –

A RecordType object using which the user can decode the binary data by using GPUdbRecord.decode_binary_data(). Available only if get_record_type is True.