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

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

const string	TRUE = "true"

const string	FALSE = "false"

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

const string	RESULT_TABLE = "result_table"
	The name of a table used to store the results, in [schema_name. More...

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

const string	EXPRESSION = "expression"
	Filter expression to apply to the table prior to unpivot processing. More...

const string	ORDER_BY = "order_by"
	Comma-separated list of the columns to be sorted by; e.g. More...

const string	CHUNK_SIZE = "chunk_size"
	Indicates the number of records per chunk to be used for the result table. More...

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

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

const string	LIMIT = "limit"
	The number of records to keep. More...

const string	TTL = "ttl"
	Sets the TTL of the table specified in RESULT_TABLE. More...

const string	VIEW_ID = "view_id"
	view this result table is part of. More...

const string	CREATE_INDEXES = "create_indexes"
	Comma-separated list of columns on which to create indexes on the table specified in RESULT_TABLE. More...

const string	RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"
	Force the result table to be replicated (ignores any sharding). More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 49 of file AggregateUnpivot.cs.

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.AggregateUnpivotRequest.Options.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.

Must be used in combination with the RESULT_TABLE option.

Definition at line 134 of file AggregateUnpivot.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.AggregateUnpivotRequest.Options.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.

Must be used in combination with the RESULT_TABLE option.

Definition at line 141 of file AggregateUnpivot.cs.

◆ CHUNK_SIZE

const string kinetica.AggregateUnpivotRequest.Options.CHUNK_SIZE = "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.

Definition at line 127 of file AggregateUnpivot.cs.

◆ COLLECTION_NAME

const string kinetica.AggregateUnpivotRequest.Options.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.

If the schema is non-existent, it will be automatically created.

Definition at line 80 of file AggregateUnpivot.cs.

◆ CREATE_INDEXES

const string kinetica.AggregateUnpivotRequest.Options.CREATE_INDEXES = "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.

Definition at line 163 of file AggregateUnpivot.cs.

◆ CREATE_TEMP_TABLE

const string kinetica.AggregateUnpivotRequest.Options.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.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 66 of file AggregateUnpivot.cs.

◆ EXPRESSION

const string kinetica.AggregateUnpivotRequest.Options.EXPRESSION = "expression"

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

Definition at line 112 of file AggregateUnpivot.cs.

◆ FALSE

const string kinetica.AggregateUnpivotRequest.Options.FALSE = "false"

Definition at line 69 of file AggregateUnpivot.cs.

◆ LIMIT

const string kinetica.AggregateUnpivotRequest.Options.LIMIT = "limit"

The number of records to keep.

The default value is ''.

Definition at line 145 of file AggregateUnpivot.cs.

◆ ORDER_BY

const string kinetica.AggregateUnpivotRequest.Options.ORDER_BY = "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 ''.

Definition at line 120 of file AggregateUnpivot.cs.

◆ RESULT_TABLE

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE = "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.

Definition at line 90 of file AggregateUnpivot.cs.

◆ RESULT_TABLE_FORCE_REPLICATED

const string kinetica.AggregateUnpivotRequest.Options.RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"

Force the result table to be replicated (ignores any sharding).

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 178 of file AggregateUnpivot.cs.

◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateUnpivotRequest.Options.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.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 108 of file AggregateUnpivot.cs.

◆ TRUE

const string kinetica.AggregateUnpivotRequest.Options.TRUE = "true"

Definition at line 68 of file AggregateUnpivot.cs.

◆ TTL

const string kinetica.AggregateUnpivotRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 150 of file AggregateUnpivot.cs.

◆ VIEW_ID

const string kinetica.AggregateUnpivotRequest.Options.VIEW_ID = "view_id"

view this result table is part of.

The default value is ''.

Definition at line 154 of file AggregateUnpivot.cs.

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

Kinetica/Protocol/AggregateUnpivot.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ CREATE_INDEXES

◆ CREATE_TEMP_TABLE

◆ EXPRESSION

◆ FALSE

◆ LIMIT

◆ ORDER_BY

◆ RESULT_TABLE

◆ RESULT_TABLE_FORCE_REPLICATED

◆ RESULT_TABLE_PERSIST

◆ TRUE

◆ TTL

◆ VIEW_ID