GPUdb C++ API  Version 6.2.0.3
Public Member Functions | Public Attributes | List of all members
gpudb::GetRecordsBySeriesRequest Struct Reference

A set of input parameters for getRecordsBySeriesRaw(const GetRecordsBySeriesRequest&) const. More...

#include <gpudb/protocol/get_records_by_series.h>

Public Member Functions

 GetRecordsBySeriesRequest ()
 Constructs a GetRecordsBySeriesRequest object with default parameter values. More...
 
 GetRecordsBySeriesRequest (const std::string &tableName_, const std::string &worldTableName_, const int32_t offset_, const int32_t limit_, const std::map< std::string, std::string > &options_)
 Constructs a GetRecordsBySeriesRequest object with the specified parameters. More...
 
 GetRecordsBySeriesRequest (const std::string &tableName_, const std::string &worldTableName_, const int32_t offset_, const int32_t limit_, const std::string &encoding_, const std::map< std::string, std::string > &options_)
 Constructs a GetRecordsBySeriesRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::string worldTableName
 
int32_t offset
 
int32_t limit
 
std::string encoding
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for getRecordsBySeriesRaw(const GetRecordsBySeriesRequest&) const.

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecordsRaw(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Definition at line 29 of file get_records_by_series.h.

Constructor & Destructor Documentation

◆ GetRecordsBySeriesRequest() [1/3]

gpudb::GetRecordsBySeriesRequest::GetRecordsBySeriesRequest ( )
inline

Constructs a GetRecordsBySeriesRequest object with default parameter values.

Definition at line 36 of file get_records_by_series.h.

◆ GetRecordsBySeriesRequest() [2/3]

gpudb::GetRecordsBySeriesRequest::GetRecordsBySeriesRequest ( const std::string &  tableName_,
const std::string &  worldTableName_,
const int32_t  offset_,
const int32_t  limit_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters
[in]tableName_Name of the collection/table/view for which series/tracks will be fetched.
[in]worldTableName_Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
[in]offset_A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]limit_A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
[in]options_Optional parameters.

Definition at line 72 of file get_records_by_series.h.

◆ GetRecordsBySeriesRequest() [3/3]

gpudb::GetRecordsBySeriesRequest::GetRecordsBySeriesRequest ( const std::string &  tableName_,
const std::string &  worldTableName_,
const int32_t  offset_,
const int32_t  limit_,
const std::string &  encoding_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters
[in]tableName_Name of the collection/table/view for which series/tracks will be fetched.
[in]worldTableName_Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
[in]offset_A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]limit_A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
[in]encoding_Specifies the encoding for returned records; either 'binary' or 'json'. The default value is gpudb::get_records_by_series_binary.
[in]options_Optional parameters.

Definition at line 117 of file get_records_by_series.h.

Member Data Documentation

◆ encoding

std::string gpudb::GetRecordsBySeriesRequest::encoding

Definition at line 131 of file get_records_by_series.h.

◆ limit

int32_t gpudb::GetRecordsBySeriesRequest::limit

Definition at line 130 of file get_records_by_series.h.

◆ offset

int32_t gpudb::GetRecordsBySeriesRequest::offset

Definition at line 129 of file get_records_by_series.h.

◆ options

std::map<std::string, std::string> gpudb::GetRecordsBySeriesRequest::options

Definition at line 132 of file get_records_by_series.h.

◆ tableName

std::string gpudb::GetRecordsBySeriesRequest::tableName

Definition at line 127 of file get_records_by_series.h.

◆ worldTableName

std::string gpudb::GetRecordsBySeriesRequest::worldTableName

Definition at line 128 of file get_records_by_series.h.

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