gpudb::GetRecordsRequest Struct Reference

A set of input parameters for getRecordsRaw(const GetRecordsRequest&) const. More...

#include <gpudb/protocol/get_records.h>

Public Member Functions
	GetRecordsRequest ()
	Constructs a GetRecordsRequest object with default parameter values. 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
int64_t	offset
int64_t	limit
std::string	encoding
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for getRecordsRaw(const GetRecordsRequest&) const.

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). 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 28 of file get_records.h.

Constructor & Destructor Documentation

GetRecordsRequest() [1/3]

gpudb::GetRecordsRequest::GetRecordsRequest ( )

inline

Constructs a GetRecordsRequest object with default parameter values.

Definition at line 34 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 from which the records will be fetched. Must be a table, view or homogeneous collection.
[in]	offset_	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). 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 max number of results should be returned.
[in]	options_	gpudb::get_records_expression: Optional filter expression to apply to the table. gpudb::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]. gpudb::get_records_true gpudb::get_records_false The default value is gpudb::get_records_true. gpudb::get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). gpudb::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. gpudb::get_records_ascending gpudb::get_records_descending The default value is gpudb::get_records_ascending.

Definition at line 95 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 from which the records will be fetched. Must be a table, view or homogeneous collection.
[in]	offset_	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). 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 max number of results should be returned.
[in]	encoding_	Specifies the encoding for returned records. gpudb::get_records_binary gpudb::get_records_json gpudb::get_records_geojson The default value is gpudb::get_records_binary.
[in]	options_	gpudb::get_records_expression: Optional filter expression to apply to the table. gpudb::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]. gpudb::get_records_true gpudb::get_records_false The default value is gpudb::get_records_true. gpudb::get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). gpudb::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. gpudb::get_records_ascending gpudb::get_records_descending The default value is gpudb::get_records_ascending.

Definition at line 164 of file get_records.h.

Member Data Documentation

encoding

std::string gpudb::GetRecordsRequest::encoding

Definition at line 176 of file get_records.h.

limit

int64_t gpudb::GetRecordsRequest::limit

Definition at line 175 of file get_records.h.

offset

int64_t gpudb::GetRecordsRequest::offset

Definition at line 174 of file get_records.h.

options

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

Definition at line 177 of file get_records.h.

tableName

std::string gpudb::GetRecordsRequest::tableName

Definition at line 173 of file get_records.h.

---

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

• gpudb/protocol/get_records.h