GPUdb C++ API  Version 6.2.0.3
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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

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.

Definition at line 260 of file get_records.h.

Constructor & Destructor Documentation

◆ RawGetRecordsResponse()

gpudb::RawGetRecordsResponse::RawGetRecordsResponse ( )
inline

Constructs a RawGetRecordsResponse object with default parameter values.

Definition at line 267 of file get_records.h.

Member Data Documentation

◆ hasMoreRecords

bool gpudb::RawGetRecordsResponse::hasMoreRecords

Definition at line 284 of file get_records.h.

◆ recordsBinary

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

Definition at line 281 of file get_records.h.

◆ recordsJson

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

Definition at line 282 of file get_records.h.

◆ tableName

std::string gpudb::RawGetRecordsResponse::tableName

Definition at line 278 of file get_records.h.

◆ totalNumberOfRecords

int64_t gpudb::RawGetRecordsResponse::totalNumberOfRecords

Definition at line 283 of file get_records.h.

◆ typeName

std::string gpudb::RawGetRecordsResponse::typeName

Definition at line 279 of file get_records.h.

◆ typeSchema

std::string gpudb::RawGetRecordsResponse::typeSchema

Definition at line 280 of file get_records.h.


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