get_records_by_column_and_decode

Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.

The list of column values to retrieve. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

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.

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.

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

• binary

• json

The default value is ‘binary’.

Allowed keys are:

• expression – Filter expression to apply to the table.

• sort_by – Column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ‘’.

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

• order_by – Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’. The default value is ‘’.

• convert_wkts_to_wkbs – If true, then WKT string columns will be returned as WKB bytes. Allowed values are:

  • true

  • false

  The default value is ‘false’.

• route_to_tom – For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.

The default value is an empty dict ( ).

The record type expected in the results, or None to determine the appropriate type automatically. If known, providing this may improve performance in binary mode. Not used in JSON mode. The default value is None.

If True, then OrderedDict objects will be returned, where string sub-type columns will have their values converted back to strings; for example, the Python datetime structs, used for datetime type columns would have their values returned as strings. If False, then Record objects will be returned, which for string sub-types, will return native or custom structs; no conversion to string takes place. String conversions, when returning OrderedDicts, incur a speed penalty, and it is strongly recommended to use the Record object option instead. If True, but none of the returned columns require a conversion, then the original Record objects will be returned. Default value is True.

Indicates if the decoded records will be transposed to be column-major or returned as is (row-major). Default value is True.