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

#include <gpudb/protocol/get_records_from_collection.h>

Public Member Functions
	RawGetRecordsFromCollectionResponse ()
	Constructs a RawGetRecordsFromCollectionResponse 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 recordsBinary or recordsJson. More...

std::vector< std::vector< uint8_t > >	recordsBinary
	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 >	recordsJson
	If the encoding parameter of the request was 'json', then this list contains the JSON 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

A set of results returned by GPUdb::getRecordsFromCollectionRaw.

Definition at line 327 of file get_records_from_collection.h.

Constructor & Destructor Documentation

◆ RawGetRecordsFromCollectionResponse()

gpudb::RawGetRecordsFromCollectionResponse::RawGetRecordsFromCollectionResponse ( )

inline

Constructs a RawGetRecordsFromCollectionResponse object with default parameters.

Definition at line 333 of file get_records_from_collection.h.

Member Data Documentation

◆ info

std::map<std::string, std::string> gpudb::RawGetRecordsFromCollectionResponse::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 399 of file get_records_from_collection.h.

◆ recordIds

std::vector<std::string> gpudb::RawGetRecordsFromCollectionResponse::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 377 of file get_records_from_collection.h.

◆ recordsBinary

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

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 363 of file get_records_from_collection.h.

◆ recordsJson

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

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

Otherwise, empty list.

Definition at line 370 of file get_records_from_collection.h.

◆ tableName

std::string gpudb::RawGetRecordsFromCollectionResponse::tableName

Value of tableName.

Definition at line 347 of file get_records_from_collection.h.

◆ typeNames

std::vector<std::string> gpudb::RawGetRecordsFromCollectionResponse::typeNames

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

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

Definition at line 356 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

Public Member Functions

Public Attributes