gpudb::GetRecordsResponse< T > Struct Template Reference

A set of output parameters for getRecords(const GetRecordsRequest&) 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

Detailed Description

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

A set of output parameters for getRecords(const GetRecordsRequest&) const.

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters

<T>	The type of object being processed.

Definition at line 344 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 351 of file get_records.h.

Member Data Documentation

template<typename T >

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

Definition at line 364 of file get_records.h.

template<typename T >

bool gpudb::GetRecordsResponse< T >::hasMoreRecords

Definition at line 366 of file get_records.h.

template<typename T >

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

Definition at line 361 of file get_records.h.

template<typename T >

int64_t gpudb::GetRecordsResponse< T >::totalNumberOfRecords

Definition at line 365 of file get_records.h.

template<typename T >

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

Definition at line 362 of file get_records.h.

template<typename T >

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

Definition at line 363 of file get_records.h.

---

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

• gpudb/protocol/get_records.h