GPUdb C++ API  Version 6.2.0.3
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 223 of file get_records_from_collection.h.

Constructor & Destructor Documentation

◆ RawGetRecordsFromCollectionResponse()

gpudb::RawGetRecordsFromCollectionResponse::RawGetRecordsFromCollectionResponse ( )
inline

Constructs a RawGetRecordsFromCollectionResponse object with default parameter values.

Definition at line 230 of file get_records_from_collection.h.

Member Data Documentation

◆ recordIds

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

Definition at line 243 of file get_records_from_collection.h.

◆ recordsBinary

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

Definition at line 241 of file get_records_from_collection.h.

◆ recordsJson

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

Definition at line 242 of file get_records_from_collection.h.

◆ tableName

std::string gpudb::RawGetRecordsFromCollectionResponse::tableName

Definition at line 239 of file get_records_from_collection.h.

◆ typeNames

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

Definition at line 240 of file get_records_from_collection.h.


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