GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::GetRecordsFromCollectionRequest Struct Reference

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

#include <gpudb/protocol/get_records_from_collection.h>

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

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 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 tables using this operation.

Definition at line 26 of file get_records_from_collection.h.

Constructor & Destructor Documentation

gpudb::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest ( )
inline

Constructs a GetRecordsFromCollectionRequest object with default parameter values.

Definition at line 33 of file get_records_from_collection.h.

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 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 max number of results 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_

Definition at line 81 of file get_records_from_collection.h.

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 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 max number of results 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'. The default value is gpudb::get_records_from_collection_binary.
[in]options_

Definition at line 139 of file get_records_from_collection.h.

Member Data Documentation

std::string gpudb::GetRecordsFromCollectionRequest::encoding

Definition at line 151 of file get_records_from_collection.h.

int64_t gpudb::GetRecordsFromCollectionRequest::limit

Definition at line 150 of file get_records_from_collection.h.

int64_t gpudb::GetRecordsFromCollectionRequest::offset

Definition at line 149 of file get_records_from_collection.h.

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

Definition at line 152 of file get_records_from_collection.h.

std::string gpudb::GetRecordsFromCollectionRequest::tableName

Definition at line 148 of file get_records_from_collection.h.


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