gpudb::AggregateUnpivotRequest Struct Reference

A set of input parameters for aggregateUnpivotRaw(const AggregateUnpivotRequest&) const. More...

#include <gpudb/protocol/aggregate_unpivot.h>

Public Member Functions
	AggregateUnpivotRequest ()
	Constructs an AggregateUnpivotRequest object with default parameter values. More...
	AggregateUnpivotRequest (const std::string &tableName_, const std::vector< std::string > &columnNames_, const std::string &variableColumnName_, const std::string &valueColumnName_, const std::vector< std::string > &pivotedColumns_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateUnpivotRequest object with the specified parameters. More...
	AggregateUnpivotRequest (const std::string &tableName_, const std::vector< std::string > &columnNames_, const std::string &variableColumnName_, const std::string &valueColumnName_, const std::vector< std::string > &pivotedColumns_, const std::string &encoding_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateUnpivotRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::vector< std::string >	columnNames
std::string	variableColumnName
std::string	valueColumnName
std::vector< std::string >	pivotedColumns
std::string	encoding
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for aggregateUnpivotRaw(const AggregateUnpivotRequest&) const.

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

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

Definition at line 36 of file aggregate_unpivot.h.

Constructor & Destructor Documentation

AggregateUnpivotRequest() [1/3]

gpudb::AggregateUnpivotRequest::AggregateUnpivotRequest ( )

inline

Constructs an AggregateUnpivotRequest object with default parameter values.

Definition at line 43 of file aggregate_unpivot.h.

AggregateUnpivotRequest() [2/3]

gpudb::AggregateUnpivotRequest::AggregateUnpivotRequest ( const std::string &  tableName_, const std::vector< std::string > &  columnNames_, const std::string &  variableColumnName_, const std::string &  valueColumnName_, const std::vector< std::string > &  pivotedColumns_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the operation will be performed. Must be an existing table/view.
[in]	columnNames_	List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
[in]	variableColumnName_	Specifies the variable/parameter column name.
[in]	valueColumnName_	Specifies the value column name.
[in]	pivotedColumns_	List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
[in]	options_	Optional parameters. gpudb::aggregate_unpivot_collection_name: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. gpudb::aggregate_unpivot_result_table: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response. gpudb::aggregate_unpivot_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false. gpudb::aggregate_unpivot_expression: Filter expression to apply to the table prior to unpivot processing. gpudb::aggregate_unpivot_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 input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. gpudb::aggregate_unpivot_chunk_size: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option. gpudb::aggregate_unpivot_limit: The number of records to keep. The default value is ''. gpudb::aggregate_unpivot_ttl: Sets the TTL of the table specified in result_table. gpudb::aggregate_unpivot_view_id: view this result table is part of. The default value is ''. gpudb::aggregate_unpivot_materialize_on_gpu: If true then the output columns will be cached on the GPU. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false. gpudb::aggregate_unpivot_create_indexes: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name. gpudb::aggregate_unpivot_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false.

Definition at line 158 of file aggregate_unpivot.h.

AggregateUnpivotRequest() [3/3]

gpudb::AggregateUnpivotRequest::AggregateUnpivotRequest ( const std::string &  tableName_, const std::vector< std::string > &  columnNames_, const std::string &  variableColumnName_, const std::string &  valueColumnName_, const std::vector< std::string > &  pivotedColumns_, const std::string &  encoding_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the operation will be performed. Must be an existing table/view.
[in]	columnNames_	List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
[in]	variableColumnName_	Specifies the variable/parameter column name.
[in]	valueColumnName_	Specifies the value column name.
[in]	pivotedColumns_	List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
[in]	encoding_	Specifies the encoding for returned records. gpudb::aggregate_unpivot_binary: Indicates that the returned records should be binary encoded. gpudb::aggregate_unpivot_json: Indicates that the returned records should be json encoded. The default value is gpudb::aggregate_unpivot_binary.
[in]	options_	Optional parameters. gpudb::aggregate_unpivot_collection_name: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. gpudb::aggregate_unpivot_result_table: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response. gpudb::aggregate_unpivot_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false. gpudb::aggregate_unpivot_expression: Filter expression to apply to the table prior to unpivot processing. gpudb::aggregate_unpivot_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 input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. gpudb::aggregate_unpivot_chunk_size: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option. gpudb::aggregate_unpivot_limit: The number of records to keep. The default value is ''. gpudb::aggregate_unpivot_ttl: Sets the TTL of the table specified in result_table. gpudb::aggregate_unpivot_view_id: view this result table is part of. The default value is ''. gpudb::aggregate_unpivot_materialize_on_gpu: If true then the output columns will be cached on the GPU. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false. gpudb::aggregate_unpivot_create_indexes: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name. gpudb::aggregate_unpivot_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. gpudb::aggregate_unpivot_true gpudb::aggregate_unpivot_false The default value is gpudb::aggregate_unpivot_false.

Definition at line 284 of file aggregate_unpivot.h.

Member Data Documentation

columnNames

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

Definition at line 296 of file aggregate_unpivot.h.

encoding

std::string gpudb::AggregateUnpivotRequest::encoding

Definition at line 300 of file aggregate_unpivot.h.

options

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

Definition at line 301 of file aggregate_unpivot.h.

pivotedColumns

std::vector<std::string> gpudb::AggregateUnpivotRequest::pivotedColumns

Definition at line 299 of file aggregate_unpivot.h.

tableName

std::string gpudb::AggregateUnpivotRequest::tableName

Definition at line 295 of file aggregate_unpivot.h.

valueColumnName

std::string gpudb::AggregateUnpivotRequest::valueColumnName

Definition at line 298 of file aggregate_unpivot.h.

variableColumnName

std::string gpudb::AggregateUnpivotRequest::variableColumnName

Definition at line 297 of file aggregate_unpivot.h.

---

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

• gpudb/protocol/aggregate_unpivot.h