gpudb::GetRecordsFromCollectionResponse< T > Struct Template Reference

A set of results returned by GPUdb::getRecordsFromCollection. More...

#include <gpudb/protocol/get_records_from_collection.h>

Public Member Functions
	GetRecordsFromCollectionResponse ()
	Constructs a GetRecordsFromCollectionResponse object with default parameters. More...

Public Attributes
std::string	tableName
	Value of tableName. More...
std::vector< std::string >	typeNames
	The type IDs of the corresponding records in data or recordsJson. More...
std::vector< T >	data
	If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. More...
std::vector< std::string >	recordIds
	If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object. More...
std::map< std::string, std::string >	info
	Additional information. More...

Detailed Description

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

A set of results returned by GPUdb::getRecordsFromCollection.

Template Parameters

T	The type of object being processed.

Definition at line 479 of file get_records_from_collection.h.

Constructor & Destructor Documentation

GetRecordsFromCollectionResponse()

template<typename T >

gpudb::GetRecordsFromCollectionResponse< T >::GetRecordsFromCollectionResponse ( )

inline

Constructs a GetRecordsFromCollectionResponse object with default parameters.

Definition at line 485 of file get_records_from_collection.h.

Member Data Documentation

data

template<typename T >

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

If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection.

Otherwise, empty list.

Definition at line 514 of file get_records_from_collection.h.

info

template<typename T >

std::map<std::string, std::string> gpudb::GetRecordsFromCollectionResponse< T >::info

Additional information.

• get_records_from_collection_total_number_of_records: Total number of records.
• get_records_from_collection_has_more_records: Too many records. Returned a partial set. Supported values:
  • get_records_from_collection_true
  • get_records_from_collection_false

The default value is an empty map.

Definition at line 543 of file get_records_from_collection.h.

recordIds

template<typename T >

std::vector<std::string> gpudb::GetRecordsFromCollectionResponse< T >::recordIds

If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object.

Otherwise it will be empty.

Definition at line 521 of file get_records_from_collection.h.

tableName

template<typename T >

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

Value of tableName.

Definition at line 498 of file get_records_from_collection.h.

typeNames

template<typename T >

std::vector<std::string> gpudb::GetRecordsFromCollectionResponse< T >::typeNames

The type IDs of the corresponding records in data or recordsJson.

This is useful when tableName is a heterogeneous collection (collections containing tables of different types).

Definition at line 507 of file get_records_from_collection.h.

---

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

• gpudb/protocol/get_records_from_collection.h