GPUdb C++ API  Version 6.2.0.3
gpudb::GetRecordsFromCollectionResponse< T > Struct Template Reference

A set of output parameters for getRecordsFromCollection(const GetRecordsFromCollectionRequest&) const. More...

#include <gpudb/protocol/get_records_from_collection.h>

Public Member Functions

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

Public Attributes

std::string tableName
 
std::vector< std::string > typeNames
 
std::vector< T > data
 
std::vector< std::string > recordIds
 

Detailed Description

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

A set of output parameters for getRecordsFromCollection(const GetRecordsFromCollectionRequest&) const.

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

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

Constructor & Destructor Documentation

◆ GetRecordsFromCollectionResponse()

Constructs a GetRecordsFromCollectionResponse object with default parameter values.

Definition at line 334 of file get_records_from_collection.h.

Member Data Documentation

◆ data

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

Definition at line 344 of file get_records_from_collection.h.

◆ recordIds

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

Definition at line 345 of file get_records_from_collection.h.

◆ tableName

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

Definition at line 342 of file get_records_from_collection.h.

◆ typeNames

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

Definition at line 343 of file get_records_from_collection.h.


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