A set of parameters for Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
More...
|
| AggregateUnpivotRequest () |
| Constructs an AggregateUnpivotRequest object with default parameters. More...
|
|
| 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. More...
|
|
| 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. More...
|
|
| KineticaData (KineticaType type) |
| Constructor from Kinetica Type More...
|
|
| KineticaData (System.Type type=null) |
| Default constructor, with optional System.Type More...
|
|
object | Get (int fieldPos) |
| Retrieve a specific property from this object More...
|
|
void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More...
|
|
A set of parameters for Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
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 41 of file AggregateUnpivot.cs.
kinetica.AggregateUnpivotRequest.AggregateUnpivotRequest |
( |
| ) |
|
|
inline |
kinetica.AggregateUnpivotRequest.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 |
|
) |
| |
|
inline |
Constructs an AggregateUnpivotRequest object with the specified parameters.
- Parameters
-
table_name | 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. |
column_names | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
variable_column_name | Specifies the variable/parameter column name. The default value is ''. |
value_column_name | Specifies the value column name. The default value is ''. |
pivoted_columns | 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. |
options | 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 /create/schema 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.
-
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 689 of file AggregateUnpivot.cs.
kinetica.AggregateUnpivotRequest.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 |
|
) |
| |
|
inline |
Constructs an AggregateUnpivotRequest object with the specified parameters.
- Parameters
-
table_name | 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. |
column_names | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
variable_column_name | Specifies the variable/parameter column name. The default value is ''. |
value_column_name | Specifies the value column name. The default value is ''. |
pivoted_columns | 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. |
encoding | 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. |
options | 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 /create/schema 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.
-
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 883 of file AggregateUnpivot.cs.
IList<string> kinetica.AggregateUnpivotRequest.column_names |
|
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 349 of file AggregateUnpivot.cs.
string kinetica.AggregateUnpivotRequest.encoding = new List<string>() |
|
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 383 of file AggregateUnpivot.cs.
IDictionary<string, string> kinetica.AggregateUnpivotRequest.options = Encoding.BINARY |
|
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 /create/schema 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.
-
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 524 of file AggregateUnpivot.cs.
IList<string> kinetica.AggregateUnpivotRequest.pivoted_columns = "" |
|
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 362 of file AggregateUnpivot.cs.
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 344 of file AggregateUnpivot.cs.
string kinetica.AggregateUnpivotRequest.value_column_name = "" |
|
getset |
string kinetica.AggregateUnpivotRequest.variable_column_name = new List<string>() |
|
getset |
Specifies the variable/parameter column name.
The default value is ''.
Definition at line 353 of file AggregateUnpivot.cs.
The documentation for this class was generated from the following file: