GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AggregateUnpivotRequest Struct Reference

A set of input parameters for 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 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

gpudb::AggregateUnpivotRequest::AggregateUnpivotRequest ( )
inline

Constructs an AggregateUnpivotRequest object with default parameter values.

Definition at line 43 of file aggregate_unpivot.h.

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.

Definition at line 166 of file aggregate_unpivot.h.

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. The default value is gpudb::aggregate_unpivot_binary.
[in]options_Optional parameters.

Definition at line 300 of file aggregate_unpivot.h.

Member Data Documentation

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

Definition at line 312 of file aggregate_unpivot.h.

std::string gpudb::AggregateUnpivotRequest::encoding

Definition at line 316 of file aggregate_unpivot.h.

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

Definition at line 317 of file aggregate_unpivot.h.

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

Definition at line 315 of file aggregate_unpivot.h.

std::string gpudb::AggregateUnpivotRequest::tableName

Definition at line 311 of file aggregate_unpivot.h.

std::string gpudb::AggregateUnpivotRequest::valueColumnName

Definition at line 314 of file aggregate_unpivot.h.

std::string gpudb::AggregateUnpivotRequest::variableColumnName

Definition at line 313 of file aggregate_unpivot.h.


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