GPUdb C++ API  Version 5.2.0.0
gpudb::RawGetRecordsResponse Struct Reference

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

#include <gpudb/protocol/get_records.h>

Public Member Functions

 RawGetRecordsResponse ()
 Constructs a RawGetRecordsResponse object with default parameter values. More...
 

Public Attributes

std::string tableName
 
std::string typeName
 
std::string typeSchema
 
std::vector< std::vector< uint8_t > > recordsBinary
 
std::vector< std::string > recordsJson
 
int64_t totalNumberOfRecords
 
bool hasMoreRecords
 

Detailed Description

A set of output 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 only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

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

Definition at line 219 of file get_records.h.

Constructor & Destructor Documentation

gpudb::RawGetRecordsResponse::RawGetRecordsResponse ( )
inline

Constructs a RawGetRecordsResponse object with default parameter values.

Definition at line 226 of file get_records.h.

Member Data Documentation

bool gpudb::RawGetRecordsResponse::hasMoreRecords

Definition at line 243 of file get_records.h.

std::vector<std::vector<uint8_t> > gpudb::RawGetRecordsResponse::recordsBinary

Definition at line 240 of file get_records.h.

std::vector<std::string> gpudb::RawGetRecordsResponse::recordsJson

Definition at line 241 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::tableName

Definition at line 237 of file get_records.h.

int64_t gpudb::RawGetRecordsResponse::totalNumberOfRecords

Definition at line 242 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::typeName

Definition at line 238 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::typeSchema

Definition at line 239 of file get_records.h.


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