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 from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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

Definition at line 47 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 54 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. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
[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. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''. gpudb::get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. gpudb::get_records_by_column_ascending gpudb::get_records_by_column_descending The default value is gpudb::get_records_by_column_ascending. gpudb::get_records_by_column_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. gpudb::get_records_by_column_convert_wkts_to_wkbs: If true, then WKT string columns will be returned as WKB bytes. gpudb::get_records_by_column_true gpudb::get_records_by_column_false The default value is gpudb::get_records_by_column_false.

Definition at line 138 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. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
[in]	encoding_	Specifies the encoding for returned records; either 'binary' or 'json'. gpudb::get_records_by_column_binary gpudb::get_records_by_column_json The default value is gpudb::get_records_by_column_binary.
[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. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''. gpudb::get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. gpudb::get_records_by_column_ascending gpudb::get_records_by_column_descending The default value is gpudb::get_records_by_column_ascending. gpudb::get_records_by_column_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. gpudb::get_records_by_column_convert_wkts_to_wkbs: If true, then WKT string columns will be returned as WKB bytes. gpudb::get_records_by_column_true gpudb::get_records_by_column_false The default value is gpudb::get_records_by_column_false.

Definition at line 231 of file get_records_by_column.h.

Member Data Documentation

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

Definition at line 242 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnRequest::encoding

Definition at line 245 of file get_records_by_column.h.

int64_t gpudb::GetRecordsByColumnRequest::limit

Definition at line 244 of file get_records_by_column.h.

int64_t gpudb::GetRecordsByColumnRequest::offset

Definition at line 243 of file get_records_by_column.h.

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

Definition at line 246 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnRequest::tableName

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