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

A set of output parameters for getRecordsFromCollectionRaw(const GetRecordsFromCollectionRequest&) const. More...

#include <gpudb/protocol/get_records_from_collection.h>

Public Member Functions

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

Public Attributes

std::string tableName
 
std::vector< std::string > typeNames
 
std::vector< std::vector< uint8_t > > recordsBinary
 
std::vector< std::string > recordsJson
 
std::vector< std::string > recordIds
 

Detailed Description

A set of output parameters for getRecordsFromCollectionRaw(const GetRecordsFromCollectionRequest&) const.

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.

Definition at line 201 of file get_records_from_collection.h.

Constructor & Destructor Documentation

gpudb::RawGetRecordsFromCollectionResponse::RawGetRecordsFromCollectionResponse ( )
inline

Constructs a RawGetRecordsFromCollectionResponse object with default parameter values.

Definition at line 208 of file get_records_from_collection.h.

Member Data Documentation

std::vector<std::string> gpudb::RawGetRecordsFromCollectionResponse::recordIds

Definition at line 221 of file get_records_from_collection.h.

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

Definition at line 219 of file get_records_from_collection.h.

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

Definition at line 220 of file get_records_from_collection.h.

std::string gpudb::RawGetRecordsFromCollectionResponse::tableName

Definition at line 217 of file get_records_from_collection.h.

std::vector<std::string> gpudb::RawGetRecordsFromCollectionResponse::typeNames

Definition at line 218 of file get_records_from_collection.h.


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