Skip to main content

A set of string constants for the parameter AggregateUnpivotRequest.options. More…

​
Static Public Attributes

const string CREATE_TEMP_TABLE = “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.
 
const string TRUE = “true”
 A boolean constant for the AggregateUnpivotRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AggregateUnpivotRequest.Options options.
 
const string COLLECTION_NAME = “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.
 
const string RESULT_TABLE = “result_table”
 The name of a table used to store the results, in [schema_name.
 
const string RESULT_TABLE_PERSIST = “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.
 
const string EXPRESSION = “expression”
 Filter expression to apply to the table prior to unpivot processing.
 
const string ORDER_BY = “order_by”
 Comma-separated list of the columns to be sorted by; e.g.
 
const string CHUNK_SIZE = “chunk_size”
 Indicates the number of records per chunk to be used for the result table.
 
const string CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
 Indicates the target maximum data size for each column in a chunk to be used for the result table.
 
const string CHUNK_MAX_MEMORY = “chunk_max_memory”
 Indicates the target maximum data size for all columns in a chunk to be used for the result table.
 
const string COMPRESSION_CODEC = “compression_codec”
 The default compression codec for the result table’s columns.
 
const string LIMIT = “limit”
 The number of records to keep.
 
const string TTL = “ttl”
 Sets the TTL of the table specified in RESULT_TABLE.
 
const string VIEW_ID = “view_id”
 View this result table is part of.
 
const string CREATE_INDEXES = “create_indexes”
 Comma-separated list of columns on which to create indexes on the table specified in RESULT_TABLE.
 
const string RESULT_TABLE_FORCE_REPLICATED = “result_table_force_replicated”
 Force the result table to be replicated (ignores any sharding).
 

​
Detailed Description

A set of string constants for the parameter AggregateUnpivotRequest.options.

Optional parameters.

Definition at line 48 of file AggregateUnpivot.cs.

​
Member Data Documentation

​
◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.AggregateUnpivotRequest.Options.CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
 static

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.

Definition at line 166 of file AggregateUnpivot.cs.

​
◆ CHUNK_MAX_MEMORY

const string kinetica.AggregateUnpivotRequest.Options.CHUNK_MAX_MEMORY = “chunk_max_memory”
 static

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.

Definition at line 173 of file AggregateUnpivot.cs.

​
◆ CHUNK_SIZE

const string kinetica.AggregateUnpivotRequest.Options.CHUNK_SIZE = “chunk_size”
 static

Indicates the number of records per chunk to be used for the result table.

Must be used in combination with the RESULT_TABLE option.

Definition at line 159 of file AggregateUnpivot.cs.

​
◆ COLLECTION_NAME

const string kinetica.AggregateUnpivotRequest.Options.COLLECTION_NAME = “collection_name”
 static

[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.

Definition at line 100 of file AggregateUnpivot.cs.

​
◆ COMPRESSION_CODEC

const string kinetica.AggregateUnpivotRequest.Options.COMPRESSION_CODEC = “compression_codec”
 static

The default compression codec for the result table’s columns.

Definition at line 179 of file AggregateUnpivot.cs.

​
◆ CREATE_INDEXES

const string kinetica.AggregateUnpivotRequest.Options.CREATE_INDEXES = “create_indexes”
 static

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.

Definition at line 203 of file AggregateUnpivot.cs.

​
◆ CREATE_TEMP_TABLE

const string kinetica.AggregateUnpivotRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”
 static

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.

Definition at line 79 of file AggregateUnpivot.cs.

​
◆ EXPRESSION

const string kinetica.AggregateUnpivotRequest.Options.EXPRESSION = “expression”
 static

Filter expression to apply to the table prior to unpivot processing.

Definition at line 144 of file AggregateUnpivot.cs.

​
◆ FALSE

const string kinetica.AggregateUnpivotRequest.Options.FALSE = “false”
 static

A boolean constant for the AggregateUnpivotRequest.Options options.

Definition at line 87 of file AggregateUnpivot.cs.

​
◆ LIMIT

const string kinetica.AggregateUnpivotRequest.Options.LIMIT = “limit”
 static

The number of records to keep.

The default value is ”.

Definition at line 183 of file AggregateUnpivot.cs.

​
◆ ORDER_BY

const string kinetica.AggregateUnpivotRequest.Options.ORDER_BY = “order_by”
 static

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 ”.

Definition at line 152 of file AggregateUnpivot.cs.

​
◆ RESULT_TABLE

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE = “result_table”
 static

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.

Definition at line 110 of file AggregateUnpivot.cs.

​
◆ RESULT_TABLE_FORCE_REPLICATED

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE_FORCE_REPLICATED = “result_table_force_replicated”
 static

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.

Definition at line 226 of file AggregateUnpivot.cs.

​
◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE_PERSIST = “result_table_persist”
 static

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.

Definition at line 140 of file AggregateUnpivot.cs.

​
◆ TRUE

const string kinetica.AggregateUnpivotRequest.Options.TRUE = “true”
 static

A boolean constant for the AggregateUnpivotRequest.Options options.

Definition at line 83 of file AggregateUnpivot.cs.

​
◆ TTL

const string kinetica.AggregateUnpivotRequest.Options.TTL = “ttl”
 static

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 189 of file AggregateUnpivot.cs.

​
◆ VIEW_ID

const string kinetica.AggregateUnpivotRequest.Options.VIEW_ID = “view_id”
 static

View this result table is part of.

The default value is ”.

Definition at line 193 of file AggregateUnpivot.cs.

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