A set of parameters for GPUdb::getRecordsBySeries. More...

#include <gpudb/protocol/get_records_by_series.h>

Public Member Functions
	GetRecordsBySeriesRequest ()
	Constructs a GetRecordsBySeriesRequest object with default parameters. 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
	Name of the table or view for which series/tracks will be fetched, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::string	worldTableName
	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [ schema_name. ]table_name format, using standard name resolution rules. More...

int32_t	offset
	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). More...

int32_t	limit
	A positive integer indicating the maximum number of series/tracks to be returned. More...

std::string	encoding
	Specifies the encoding for returned records; either binary or json. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::getRecordsBySeries.

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 GPUdb::getRecords 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 parameters.

Definition at line 35 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 table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
[in]	worldTableName_	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName_, in [schema_name.]table_name format, using standard name resolution rules. 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 default value is 0. 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. The default value is 250.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 81 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 table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.
[in]	worldTableName_	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName_, in [schema_name.]table_name format, using standard name resolution rules. 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 default value is 0. 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. The default value is 250.
[in]	encoding_	Specifies the encoding for returned records; either binary or json. Supported values: get_records_by_series_binary get_records_by_series_json The default value is get_records_by_series_binary.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 143 of file get_records_by_series.h.

Member Data Documentation

◆ encoding

std::string gpudb::GetRecordsBySeriesRequest::encoding

Specifies the encoding for returned records; either binary or json.

Supported values:

The default value is get_records_by_series_binary.

Definition at line 202 of file get_records_by_series.h.

◆ limit

int32_t gpudb::GetRecordsBySeriesRequest::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. The default value is 250.

Definition at line 186 of file get_records_by_series.h.

◆ offset

int32_t gpudb::GetRecordsBySeriesRequest::offset

A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results).

The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 179 of file get_records_by_series.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 207 of file get_records_by_series.h.

◆ tableName

std::string gpudb::GetRecordsBySeriesRequest::tableName

Name of the table or view for which series/tracks will be fetched, in [ schema_name. ]table_name format, using standard name resolution rules.

Definition at line 159 of file get_records_by_series.h.

◆ worldTableName

std::string gpudb::GetRecordsBySeriesRequest::worldTableName

Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [ schema_name. ]table_name format, using standard name resolution rules.

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.

Definition at line 171 of file get_records_by_series.h.

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

gpudb/protocol/get_records_by_series.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GetRecordsBySeriesRequest() [1/3]

◆ GetRecordsBySeriesRequest() [2/3]

◆ GetRecordsBySeriesRequest() [3/3]

Member Data Documentation

◆ encoding

◆ limit

◆ offset

◆ options

◆ tableName

◆ worldTableName