GPUdb C++ API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
gpudb::RawGetRecordsByColumnResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/get_records_by_column.h>

Public Member Functions

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

Public Attributes

std::string tableName
 
std::string responseSchemaStr
 
std::vector< uint8_t > binaryEncodedResponse
 
std::string jsonEncodedResponse
 
int64_t totalNumberOfRecords
 
bool hasMoreRecords
 

Detailed Description

A set of output parameters for const.

For a given table, retrieves the values of the given columns within a given range. It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Definition at line 282 of file get_records_by_column.h.

Constructor & Destructor Documentation

gpudb::RawGetRecordsByColumnResponse::RawGetRecordsByColumnResponse ( )
inline

Constructs a RawGetRecordsByColumnResponse object with default parameter values.

Definition at line 289 of file get_records_by_column.h.

Member Data Documentation

std::vector<uint8_t> gpudb::RawGetRecordsByColumnResponse::binaryEncodedResponse

Definition at line 301 of file get_records_by_column.h.

bool gpudb::RawGetRecordsByColumnResponse::hasMoreRecords

Definition at line 304 of file get_records_by_column.h.

std::string gpudb::RawGetRecordsByColumnResponse::jsonEncodedResponse

Definition at line 302 of file get_records_by_column.h.

std::string gpudb::RawGetRecordsByColumnResponse::responseSchemaStr

Definition at line 300 of file get_records_by_column.h.

std::string gpudb::RawGetRecordsByColumnResponse::tableName

Definition at line 299 of file get_records_by_column.h.

int64_t gpudb::RawGetRecordsByColumnResponse::totalNumberOfRecords

Definition at line 303 of file get_records_by_column.h.


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