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

#include <gpudb/protocol/aggregate_unique.h>

Public Member Functions
	AggregateUniqueRequest ()
	Constructs an AggregateUniqueRequest object with default parameter values. More...

	AggregateUniqueRequest (const std::string &tableName_, const std::string &columnName_, const int64_t offset_, const int64_t limit_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateUniqueRequest object with the specified parameters. More...

	AggregateUniqueRequest (const std::string &tableName_, const std::string &columnName_, const int64_t offset_, const int64_t limit_, const std::string &encoding_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateUniqueRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::string	columnName

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.

Returns all the unique values from a particular column (specified by columnName) of a particular table (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

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

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when the value of columnName is an unrestricted-length string.

Definition at line 50 of file aggregate_unique.h.

Constructor & Destructor Documentation

gpudb::AggregateUniqueRequest::AggregateUniqueRequest ( )

inline

Constructs an AggregateUniqueRequest object with default parameter values.

Definition at line 57 of file aggregate_unique.h.

gpudb::AggregateUniqueRequest::AggregateUniqueRequest	(	const std::string &	tableName_,
		const std::string &	columnName_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the operation will be performed. Must be an existing table.
[in]	columnName_	Name of the column or an expression containing one or more column names on which the unique function would be applied.
[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 max number of results should be returned.
[in]	options_	Optional parameters. gpudb::aggregate_unique_collection_name: Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. gpudb::aggregate_unique_expression: Optional filter expression to apply to the table. gpudb::aggregate_unique_sort_order: String indicating how the returned values should be sorted. gpudb::aggregate_unique_ascending gpudb::aggregate_unique_descending gpudb::aggregate_unique_result_table: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. gpudb::aggregate_unique_result_table_persist: If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. gpudb::aggregate_unique_true gpudb::aggregate_unique_false gpudb::aggregate_unique_ttl: Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.

Definition at line 135 of file aggregate_unique.h.

gpudb::AggregateUniqueRequest::AggregateUniqueRequest	(	const std::string &	tableName_,
		const std::string &	columnName_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::string &	encoding_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AggregateUniqueRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the operation will be performed. Must be an existing table.
[in]	columnName_	Name of the column or an expression containing one or more column names on which the unique function would be applied.
[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 max number of results should be returned.
[in]	encoding_	Specifies the encoding for returned records. gpudb::aggregate_unique_binary: Indicates that the returned records should be binary encoded. gpudb::aggregate_unique_json: Indicates that the returned records should be json encoded.
[in]	options_	Optional parameters. gpudb::aggregate_unique_collection_name: Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail. gpudb::aggregate_unique_expression: Optional filter expression to apply to the table. gpudb::aggregate_unique_sort_order: String indicating how the returned values should be sorted. gpudb::aggregate_unique_ascending gpudb::aggregate_unique_descending gpudb::aggregate_unique_result_table: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. gpudb::aggregate_unique_result_table_persist: If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. gpudb::aggregate_unique_true gpudb::aggregate_unique_false gpudb::aggregate_unique_ttl: Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.

Definition at line 222 of file aggregate_unique.h.

Member Data Documentation

std::string gpudb::AggregateUniqueRequest::columnName

Definition at line 233 of file aggregate_unique.h.

std::string gpudb::AggregateUniqueRequest::encoding

Definition at line 236 of file aggregate_unique.h.

int64_t gpudb::AggregateUniqueRequest::limit

Definition at line 235 of file aggregate_unique.h.

int64_t gpudb::AggregateUniqueRequest::offset

Definition at line 234 of file aggregate_unique.h.

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

Definition at line 237 of file aggregate_unique.h.

std::string gpudb::AggregateUniqueRequest::tableName

Definition at line 232 of file aggregate_unique.h.

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

gpudb/protocol/aggregate_unique.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation