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

#include <gpudb/protocol/get_records_from_collection.h>

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

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

	GetRecordsFromCollectionRequest (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 GetRecordsFromCollectionRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	Name of the collection or table from which records are to be retrieved, 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; either binary or json. More...

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

Detailed Description

A set of parameters for GPUdb::getRecordsFromCollection.

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb::deleteRecords.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)

Definition at line 28 of file get_records_from_collection.h.

Constructor & Destructor Documentation

◆ GetRecordsFromCollectionRequest() [1/3]

gpudb::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest ( )

inline

Constructs a GetRecordsFromCollectionRequest object with default parameters.

Definition at line 34 of file get_records_from_collection.h.

◆ GetRecordsFromCollectionRequest() [2/3]

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

inline

Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Parameters

[in]	tableName_	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.
[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 offset_ & limit_ to request subsequent pages of results. The default value is -9999.
[in]	options_	get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: get_records_from_collection_true get_records_from_collection_false The default value is get_records_from_collection_false. get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''. The default value is an empty map.

Definition at line 98 of file get_records_from_collection.h.

◆ GetRecordsFromCollectionRequest() [3/3]

gpudb::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest	(	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 GetRecordsFromCollectionRequest object with the specified parameters.

Parameters

[in]	tableName_	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.
[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 offset_ & limit_ to request subsequent pages of results. The default value is -9999.
[in]	encoding_	Specifies the encoding for returned records; either binary or json. Supported values: get_records_from_collection_binary get_records_from_collection_json The default value is get_records_from_collection_binary.
[in]	options_	get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: get_records_from_collection_true get_records_from_collection_false The default value is get_records_from_collection_false. get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''. The default value is an empty map.

Definition at line 180 of file get_records_from_collection.h.

Member Data Documentation

◆ encoding

std::string gpudb::GetRecordsFromCollectionRequest::encoding

Specifies the encoding for returned records; either binary or json.

Supported values:

The default value is get_records_from_collection_binary.

Definition at line 232 of file get_records_from_collection.h.

◆ limit

int64_t gpudb::GetRecordsFromCollectionRequest::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 offset & limit to request subsequent pages of results. The default value is -9999.

Definition at line 216 of file get_records_from_collection.h.

◆ offset

int64_t gpudb::GetRecordsFromCollectionRequest::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 204 of file get_records_from_collection.h.

◆ options

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

get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values:
- get_records_from_collection_true
- get_records_from_collection_false
The default value is get_records_from_collection_false.
get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.

The default value is an empty map.

Definition at line 256 of file get_records_from_collection.h.

◆ tableName

std::string gpudb::GetRecordsFromCollectionRequest::tableName

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.

Definition at line 196 of file get_records_from_collection.h.

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

gpudb/protocol/get_records_from_collection.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GetRecordsFromCollectionRequest() [1/3]

◆ GetRecordsFromCollectionRequest() [2/3]

◆ GetRecordsFromCollectionRequest() [3/3]

Member Data Documentation

◆ encoding

◆ limit

◆ offset

◆ options

◆ tableName