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

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) 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 tables using this operation.

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. Must be an existing GPUdb 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). 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 max number of results should be returned. Default value is 10000.
[in]	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::map.

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. Must be an existing GPUdb 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). 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 max number of results should be returned. Default value is 10000.
[in]	encoding	Specifies the encoding for returned records; either 'binary' or 'json'. Values: 'binary', 'json'. Default value is 'binary'.
[in]	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::map.

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: