Skip to main content

A set of parameters for Kinetica.aggregateUnpivot. More…

Inheritance diagram for kinetica.AggregateUnpivotRequest:
[legend]
Collaboration diagram for kinetica.AggregateUnpivotRequest:
[legend]

​
Classes

struct  Encoding
 A set of string constants for the parameter AggregateUnpivotRequest.encoding. More…
 
struct  Options
 A set of string constants for the parameter AggregateUnpivotRequest.options. More…
 

​
Public Member Functions

 AggregateUnpivotRequest ()
 Constructs an AggregateUnpivotRequest object with default parameters.
 
 AggregateUnpivotRequest (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null)
 Constructs an AggregateUnpivotRequest object with the specified parameters.
 
 AggregateUnpivotRequest (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, string encoding=null, IDictionary< string, string > options=null)
 Constructs an AggregateUnpivotRequest object with the specified parameters.
 
 AggregateUnpivotRequest ()
 Constructs an AggregateUnpivotRequest object with default parameters.
 
 AggregateUnpivotRequest (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null)
 Constructs an AggregateUnpivotRequest object with the specified parameters.
 
 AggregateUnpivotRequest (string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, string encoding=null, IDictionary< string, string > options=null)
 Constructs an AggregateUnpivotRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 Name of the table on which the operation will be performed.
 
IList< string > column_names = new List<string>() [get, set]
 List of column names or expressions.
 
string variable_column_name = "" [get, set]
 Specifies the variable/parameter column name.
 
string value_column_name = "" [get, set]
 Specifies the value column name.
 
IList< string > pivoted_columns = new List<string>() [get, set]
 List of one or more values typically the column names of the input table.
 
string encoding = Encoding.BINARY [get, set]
 Specifies the encoding for returned records.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.aggregateUnpivot.

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 28 of file AggregateUnpivot.cs.

​
Constructor & Destructor Documentation

​
◆ AggregateUnpivotRequest() [1/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest ()
 inline

Constructs an AggregateUnpivotRequest object with default parameters.

Definition at line 494 of file AggregateUnpivot.cs.

​
◆ AggregateUnpivotRequest() [2/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest (stringtable_name,
IList< string >column_names,
stringvariable_column_name,
stringvalue_column_name,
IList< string >pivoted_columns,
IDictionary< string, string >options = null )
 inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.
column_namesList of column names or expressions. A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.
variable_column_nameSpecifies the variable/parameter column name. The default value is ”.
value_column_nameSpecifies the value column name. The default value is ”.
pivoted_columnsList 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.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema is non-existent, it will be automatically created.
  • RESULT_TABLE: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 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. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • 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 ”.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  • LIMIT: The number of records to keep. The default value is ”.
  • TTL: Sets the TTL of the table specified in RESULT_TABLE.
  • VIEW_ID: View this result table is part of. The default value is ”.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 726 of file AggregateUnpivot.cs.

​
◆ AggregateUnpivotRequest() [3/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest (stringtable_name,
IList< string >column_names,
stringvariable_column_name,
stringvalue_column_name,
IList< string >pivoted_columns,
stringencoding = null,
IDictionary< string, string >options = null )
 inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.
column_namesList of column names or expressions. A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.
variable_column_nameSpecifies the variable/parameter column name. The default value is ”.
value_column_nameSpecifies the value column name. The default value is ”.
pivoted_columnsList 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.
encodingSpecifies the encoding for returned records. Supported values:
  • BINARY: Indicates that the returned records should be binary encoded.
  • JSON: Indicates that the returned records should be JSON-encoded.
The default value is BINARY.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema is non-existent, it will be automatically created.
  • RESULT_TABLE: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 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. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • 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 ”.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  • LIMIT: The number of records to keep. The default value is ”.
  • TTL: Sets the TTL of the table specified in RESULT_TABLE.
  • VIEW_ID: View this result table is part of. The default value is ”.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 991 of file AggregateUnpivot.cs.

​
◆ AggregateUnpivotRequest() [4/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest ()
 inline

Constructs an AggregateUnpivotRequest object with default parameters.

Definition at line 494 of file AggregateUnpivot.cs.

​
◆ AggregateUnpivotRequest() [5/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest (stringtable_name,
IList< string >column_names,
stringvariable_column_name,
stringvalue_column_name,
IList< string >pivoted_columns,
IDictionary< string, string >options = null )
 inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.
column_namesList of column names or expressions. A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.
variable_column_nameSpecifies the variable/parameter column name. The default value is ”.
value_column_nameSpecifies the value column name. The default value is ”.
pivoted_columnsList 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.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema is non-existent, it will be automatically created.
  • RESULT_TABLE: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 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. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • 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 ”.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  • LIMIT: The number of records to keep. The default value is ”.
  • TTL: Sets the TTL of the table specified in RESULT_TABLE.
  • VIEW_ID: View this result table is part of. The default value is ”.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 726 of file AggregateUnpivot.cs.

​
◆ AggregateUnpivotRequest() [6/6]

kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest (stringtable_name,
IList< string >column_names,
stringvariable_column_name,
stringvalue_column_name,
IList< string >pivoted_columns,
stringencoding = null,
IDictionary< string, string >options = null )
 inline

Constructs an AggregateUnpivotRequest object with the specified parameters.

Parameters
table_nameName of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.
column_namesList of column names or expressions. A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.
variable_column_nameSpecifies the variable/parameter column name. The default value is ”.
value_column_nameSpecifies the value column name. The default value is ”.
pivoted_columnsList 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.
encodingSpecifies the encoding for returned records. Supported values:
  • BINARY: Indicates that the returned records should be binary encoded.
  • JSON: Indicates that the returned records should be JSON-encoded.
The default value is BINARY.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema is non-existent, it will be automatically created.
  • RESULT_TABLE: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 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. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • 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 ”.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  • LIMIT: The number of records to keep. The default value is ”.
  • TTL: Sets the TTL of the table specified in RESULT_TABLE.
  • VIEW_ID: View this result table is part of. The default value is ”.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 991 of file AggregateUnpivot.cs.

​
Property Documentation

​
◆ column_names

IList< string > kinetica.AggregateUnpivotRequest.column_names = new List<string>()
 getset

List of column names or expressions.

A wildcard ’*’ can be used to include all the non-pivoted columns from the source table.

Definition at line 240 of file AggregateUnpivot.cs.

​
◆ encoding

string kinetica.AggregateUnpivotRequest.encoding = Encoding.BINARY
 getset

Specifies the encoding for returned records.

Supported values:

  • BINARY: Indicates that the returned records should be binary encoded.
  • JSON: Indicates that the returned records should be JSON-encoded.

The default value is BINARY.

Definition at line 276 of file AggregateUnpivot.cs.

​
◆ options

IDictionary< string, string > kinetica.AggregateUnpivotRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema is non-existent, it will be automatically created.
  • RESULT_TABLE: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
  • 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. Supported values:The default value is FALSE.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • 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 ”.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.
  • COMPRESSION_CODEC: The default compression codec for the result table’s columns.
  • LIMIT: The number of records to keep. The default value is ”.
  • TTL: Sets the TTL of the table specified in RESULT_TABLE.
  • VIEW_ID: View this result table is part of. The default value is ”.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 490 of file AggregateUnpivot.cs.

​
◆ pivoted_columns

IList< string > kinetica.AggregateUnpivotRequest.pivoted_columns = new List<string>()
 getset

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.

Definition at line 254 of file AggregateUnpivot.cs.

​
◆ table_name

string kinetica.AggregateUnpivotRequest.table_name
 getset

Name of the table on which the operation will be performed.

Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules.

Definition at line 235 of file AggregateUnpivot.cs.

​
◆ value_column_name

string kinetica.AggregateUnpivotRequest.value_column_name = ""
 getset

Specifies the value column name.

The default value is ”.

Definition at line 248 of file AggregateUnpivot.cs.

​
◆ variable_column_name

string kinetica.AggregateUnpivotRequest.variable_column_name = ""
 getset

Specifies the variable/parameter column name.

The default value is ”.

Definition at line 244 of file AggregateUnpivot.cs.

The documentation for this class was generated from the following files: