Skip to main content

A set of string constants for the parameter AggregateUniqueRequest.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 AggregateUniqueRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AggregateUniqueRequest.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 EXPRESSION = “expression”
 Filter expression to apply to the table.
 
const string SORT_ORDER = “sort_order”
 String indicating how the returned values should be sorted.
 
const string ASCENDING = “ascending”
 A constant for the AggregateUniqueRequest.Options options.
 
const string DESCENDING = “descending”
 A constant for the AggregateUniqueRequest.Options options.
 
const string ORDER_BY = “order_by”
 Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’.
 
const string RESULT_TABLE = “result_table”
 The name of the 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 RESULT_TABLE_FORCE_REPLICATED = “result_table_force_replicated”
 Force the result table to be replicated (ignores any sharding).
 
const string RESULT_TABLE_GENERATE_PK = “result_table_generate_pk”
 If TRUE then set a primary key for the result table.
 
const string TTL = “ttl”
 Sets the TTL of the table specified in RESULT_TABLE.
 
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 VIEW_ID = “view_id”
 ID of view of which the result table will be a member.
 

​
Detailed Description

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

Optional parameters.

Definition at line 63 of file AggregateUnique.cs.

​
Member Data Documentation

​
◆ ASCENDING

const string kinetica.AggregateUniqueRequest.Options.ASCENDING = “ascending”
 static

A constant for the AggregateUniqueRequest.Options options.

Definition at line 142 of file AggregateUnique.cs.

​
◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.AggregateUniqueRequest.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 261 of file AggregateUnique.cs.

​
◆ CHUNK_MAX_MEMORY

const string kinetica.AggregateUniqueRequest.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 268 of file AggregateUnique.cs.

​
◆ CHUNK_SIZE

const string kinetica.AggregateUniqueRequest.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 254 of file AggregateUnique.cs.

​
◆ COLLECTION_NAME

const string kinetica.AggregateUniqueRequest.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 provided is non-existent, it will be automatically created.

Definition at line 115 of file AggregateUnique.cs.

​
◆ COMPRESSION_CODEC

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

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

Definition at line 274 of file AggregateUnique.cs.

​
◆ CREATE_TEMP_TABLE

const string kinetica.AggregateUniqueRequest.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 94 of file AggregateUnique.cs.

​
◆ DESCENDING

const string kinetica.AggregateUniqueRequest.Options.DESCENDING = “descending”
 static

A constant for the AggregateUniqueRequest.Options options.

Definition at line 146 of file AggregateUnique.cs.

​
◆ EXPRESSION

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

Filter expression to apply to the table.

Definition at line 118 of file AggregateUnique.cs.

​
◆ FALSE

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

A boolean constant for the AggregateUniqueRequest.Options options.

Definition at line 102 of file AggregateUnique.cs.

​
◆ ORDER_BY

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

Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., ‘timestamp asc, x desc’.

The default value is ”.

Definition at line 152 of file AggregateUnique.cs.

​
◆ RESULT_TABLE

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

The name of the 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. Not available if AggregateUniqueRequest.column_name is an unrestricted-length string.

Definition at line 164 of file AggregateUnique.cs.

​
◆ RESULT_TABLE_FORCE_REPLICATED

const string kinetica.AggregateUniqueRequest.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 217 of file AggregateUnique.cs.

​
◆ RESULT_TABLE_GENERATE_PK

const string kinetica.AggregateUniqueRequest.Options.RESULT_TABLE_GENERATE_PK = “result_table_generate_pk”
 static

If TRUE then set a primary key for the result table.

Must be used in combination with the RESULT_TABLE option. Supported values:

The default value is FALSE.

Definition at line 241 of file AggregateUnique.cs.

​
◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateUniqueRequest.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 194 of file AggregateUnique.cs.

​
◆ SORT_ORDER

const string kinetica.AggregateUniqueRequest.Options.SORT_ORDER = “sort_order”
 static

String indicating how the returned values should be sorted.

Supported values:

The default value is ASCENDING.

Definition at line 138 of file AggregateUnique.cs.

​
◆ TRUE

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

A boolean constant for the AggregateUniqueRequest.Options options.

Definition at line 98 of file AggregateUnique.cs.

​
◆ TTL

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

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 247 of file AggregateUnique.cs.

​
◆ VIEW_ID

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

ID of view of which the result table will be a member.

The default value is ”.

Definition at line 279 of file AggregateUnique.cs.

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