A set of input parameters for const. More...

Public Member Functions
	GetRecordsFromCollectionRequest ()
	Constructs a GetRecordsFromCollectionRequest object with default parameter values. 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...

Detailed Description

A set of input parameters for const.

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

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)

Constructor & Destructor Documentation

gpudb::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest ( )

inline

Constructs a GetRecordsFromCollectionRequest object with default parameter values.

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 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.
[in]	options_	gpudb::get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. gpudb::get_records_from_collection_true gpudb::get_records_from_collection_false The default value is gpudb::get_records_from_collection_false. gpudb::get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.

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 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.
[in]	encoding_	Specifies the encoding for returned records; either binary or json. gpudb::get_records_from_collection_binary gpudb::get_records_from_collection_json The default value is gpudb::get_records_from_collection_binary.
[in]	options_	gpudb::get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. gpudb::get_records_from_collection_true gpudb::get_records_from_collection_false The default value is gpudb::get_records_from_collection_false. gpudb::get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.

std::string gpudb::GetRecordsFromCollectionRequest::encoding

int64_t gpudb::GetRecordsFromCollectionRequest::limit

int64_t gpudb::GetRecordsFromCollectionRequest::offset

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

std::string gpudb::GetRecordsFromCollectionRequest::tableName

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