A set of parameters for GPUdb::getRecords. More...

#include <gpudb/protocol/get_records.h>

Public Member Functions
	GetRecordsRequest ()
	Constructs a GetRecordsRequest object with default parameters. More...

	GetRecordsRequest (const std::string &tableName_, const int64_t offset_, const int64_t limit_, const std::map< std::string, std::string > &options_)
	Constructs a GetRecordsRequest object with the specified parameters. More...

	GetRecordsRequest (const std::string &tableName_, const int64_t offset_, const int64_t limit_, const std::string &encoding_, const std::map< std::string, std::string > &options_)
	Constructs a GetRecordsRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	Name of the table or view from which the records will be fetched, in [ schema_name. ]table_name format, using standard name resolution rules. More...

int64_t	offset
	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More...

int64_t	limit
	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. More...

std::string	encoding
	Specifies the encoding for returned records; one of binary, json, or geojson. More...

std::map< std::string, std::string >	options

Detailed Description

A set of parameters for GPUdb::getRecords.

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

Definition at line 26 of file get_records.h.

Constructor & Destructor Documentation

◆ GetRecordsRequest() [1/3]

gpudb::GetRecordsRequest::GetRecordsRequest ( )

inline

Constructs a GetRecordsRequest object with default parameters.

Definition at line 31 of file get_records.h.

◆ GetRecordsRequest() [2/3]

gpudb::GetRecordsRequest::GetRecordsRequest	(	const std::string &	tableName_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a GetRecordsRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
[in]	offset_	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.
[in]	limit_	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 hasMoreRecords to see if more records exist in the result to be fetched, and offset_ & limit_ to request subsequent pages of results. The default value is -9999.
[in]	options_	get_records_expression: Optional filter expression to apply to the table. get_records_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]. Supported values: get_records_true get_records_false The default value is get_records_true. get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). get_records_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. Supported values: get_records_ascending get_records_descending The default value is get_records_ascending. The default value is an empty map.

Definition at line 120 of file get_records.h.

◆ GetRecordsRequest() [3/3]

gpudb::GetRecordsRequest::GetRecordsRequest	(	const std::string &	tableName_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::string &	encoding_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a GetRecordsRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
[in]	offset_	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.
[in]	limit_	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 hasMoreRecords to see if more records exist in the result to be fetched, and offset_ & limit_ to request subsequent pages of results. The default value is -9999.
[in]	encoding_	Specifies the encoding for returned records; one of binary, json, or geojson. Supported values: get_records_binary get_records_json get_records_geojson The default value is get_records_binary.
[in]	options_	get_records_expression: Optional filter expression to apply to the table. get_records_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]. Supported values: get_records_true get_records_false The default value is get_records_true. get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). get_records_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. Supported values: get_records_ascending get_records_descending The default value is get_records_ascending. The default value is an empty map.

Definition at line 225 of file get_records.h.

Member Data Documentation

◆ encoding

std::string gpudb::GetRecordsRequest::encoding

Specifies the encoding for returned records; one of binary, json, or geojson.

Supported values:

The default value is get_records_binary.

Definition at line 277 of file get_records.h.

◆ limit

int64_t gpudb::GetRecordsRequest::limit

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 hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results. The default value is -9999.

Definition at line 262 of file get_records.h.

◆ offset

int64_t gpudb::GetRecordsRequest::offset

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.

Definition at line 248 of file get_records.h.

◆ options

std::map<std::string, std::string> gpudb::GetRecordsRequest::options

get_records_expression: Optional filter expression to apply to the table.
get_records_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]. Supported values:
- get_records_true
- get_records_false
The default value is get_records_true.
get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
get_records_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. Supported values:
- get_records_ascending
- get_records_descending
The default value is get_records_ascending.

The default value is an empty map.

Definition at line 316 of file get_records.h.

◆ tableName

std::string gpudb::GetRecordsRequest::tableName

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

Definition at line 240 of file get_records.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/get_records.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GetRecordsRequest() [1/3]

◆ GetRecordsRequest() [2/3]

◆ GetRecordsRequest() [3/3]

Member Data Documentation

◆ encoding

◆ limit

◆ offset

◆ options

◆ tableName