A set of input parameters for const. More...

#include <gpudb/protocol/get_records_by_column.h>

Public Member Functions
	GetRecordsByColumnRequest ()
	Constructs a GetRecordsByColumnRequest object with default parameter values. More...

	GetRecordsByColumnRequest (const std::string &tableName_, const std::vector< std::string > &columnNames_, const int64_t offset_, const int64_t limit_, const std::map< std::string, std::string > &options_)
	Constructs a GetRecordsByColumnRequest object with the specified parameters. More...

	GetRecordsByColumnRequest (const std::string &tableName_, const std::vector< std::string > &columnNames_, const int64_t offset_, const int64_t limit_, const std::string &encoding_, const std::map< std::string, std::string > &options_)
	Constructs a GetRecordsByColumnRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::vector< std::string >	columnNames

int64_t	offset

int64_t	limit

std::string	encoding

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

Detailed Description

A set of input parameters for const.

For a given table, retrieves the values of the given columns within a given range. It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset + limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Definition at line 36 of file get_records_by_column.h.

Constructor & Destructor Documentation

gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest ( )

inline

Constructs a GetRecordsByColumnRequest object with default parameter values.

Definition at line 43 of file get_records_by_column.h.

gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest	(	const std::string &	tableName_,
		const std::vector< std::string > &	columnNames_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which this operation will be performed. The table cannot be a parent set.
[in]	columnNames_	The list of column values to retrieve.
[in]	offset_	A positive integer indicating the number of initial results to skip (this can be 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 results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
[in]	options_	gpudb::get_records_by_column_expression: Optional filter expression to apply to the table. gpudb::get_records_by_column_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). gpudb::get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. gpudb::get_records_by_column_ascending gpudb::get_records_by_column_descending gpudb::get_records_by_column_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 104 of file get_records_by_column.h.

gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest	(	const std::string &	tableName_,
		const std::vector< std::string > &	columnNames_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::string &	encoding_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a GetRecordsByColumnRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which this operation will be performed. The table cannot be a parent set.
[in]	columnNames_	The list of column values to retrieve.
[in]	offset_	A positive integer indicating the number of initial results to skip (this can be 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 results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
[in]	encoding_	Specifies the encoding for returned records; either 'binary' or 'json'. gpudb::get_records_by_column_binary gpudb::get_records_by_column_json
[in]	options_	gpudb::get_records_by_column_expression: Optional filter expression to apply to the table. gpudb::get_records_by_column_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). gpudb::get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. Default is 'ascending'. If sort_order is provided, sort_by has to be provided. gpudb::get_records_by_column_ascending gpudb::get_records_by_column_descending gpudb::get_records_by_column_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 172 of file get_records_by_column.h.

Member Data Documentation

std::vector<std::string> gpudb::GetRecordsByColumnRequest::columnNames

Definition at line 183 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnRequest::encoding

Definition at line 186 of file get_records_by_column.h.

int64_t gpudb::GetRecordsByColumnRequest::limit

Definition at line 185 of file get_records_by_column.h.

int64_t gpudb::GetRecordsByColumnRequest::offset

Definition at line 184 of file get_records_by_column.h.

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

Definition at line 187 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnRequest::tableName

Definition at line 182 of file get_records_by_column.h.

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

gpudb/protocol/get_records_by_column.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation