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

A set of output parameters for 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
 
std::map< std::string,
std::string > 
info
 

Detailed Description

A set of output parameters for 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 274 of file get_records.h.

Constructor & Destructor Documentation

gpudb::RawGetRecordsResponse::RawGetRecordsResponse ( )
inline

Constructs a RawGetRecordsResponse object with default parameter values.

Definition at line 281 of file get_records.h.

Member Data Documentation

bool gpudb::RawGetRecordsResponse::hasMoreRecords

Definition at line 299 of file get_records.h.

std::map<std::string, std::string> gpudb::RawGetRecordsResponse::info

Definition at line 300 of file get_records.h.

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

Definition at line 296 of file get_records.h.

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

Definition at line 297 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::tableName

Definition at line 293 of file get_records.h.

int64_t gpudb::RawGetRecordsResponse::totalNumberOfRecords

Definition at line 298 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::typeName

Definition at line 294 of file get_records.h.

std::string gpudb::RawGetRecordsResponse::typeSchema

Definition at line 295 of file get_records.h.


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