GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::GetRecordsResponse< T > Struct Template Reference

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

#include <gpudb/protocol/get_records.h>

Public Member Functions

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

Public Attributes

std::string tableName
 
std::string typeName
 
std::string typeSchema
 
std::vector< T > data
 
int64_t totalNumberOfRecords
 
bool hasMoreRecords
 
std::map< std::string,
std::string > 
info
 

Detailed Description

template<typename T>
struct gpudb::GetRecordsResponse< T >

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.

Parameters
<T>The type of object being processed.

Definition at line 404 of file get_records.h.

Constructor & Destructor Documentation

template<typename T>
gpudb::GetRecordsResponse< T >::GetRecordsResponse ( )
inline

Constructs a GetRecordsResponse object with default parameter values.

Definition at line 411 of file get_records.h.

Member Data Documentation

template<typename T>
std::vector<T> gpudb::GetRecordsResponse< T >::data

Definition at line 425 of file get_records.h.

template<typename T>
bool gpudb::GetRecordsResponse< T >::hasMoreRecords

Definition at line 427 of file get_records.h.

template<typename T>
std::map<std::string, std::string> gpudb::GetRecordsResponse< T >::info

Definition at line 428 of file get_records.h.

template<typename T>
std::string gpudb::GetRecordsResponse< T >::tableName

Definition at line 422 of file get_records.h.

template<typename T>
int64_t gpudb::GetRecordsResponse< T >::totalNumberOfRecords

Definition at line 426 of file get_records.h.

template<typename T>
std::string gpudb::GetRecordsResponse< T >::typeName

Definition at line 423 of file get_records.h.

template<typename T>
std::string gpudb::GetRecordsResponse< T >::typeSchema

Definition at line 424 of file get_records.h.


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