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	EXPRESSION = "expression"
	Optional filter expression to apply to the table. More...

const string	SORT_ORDER = "sort_order"
	String indicating how the returned values should be sorted. More...

const string	ASCENDING = "ascending"

const string	DESCENDING = "descending"

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

const string	RESULT_TABLE = "result_table"
	The name of the 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	RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"
	Force the result table to be replicated (ignores any sharding). More...

const string	RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"
	If TRUE then set a primary key for the result table. More...

const string	TTL = "ttl"
	Sets the TTL of the table specified in RESULT_TABLE. 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	VIEW_ID = "view_id"
	ID of view of which the result table will be a member. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 68 of file AggregateUnique.cs.

Member Data Documentation

◆ ASCENDING

const string kinetica.AggregateUniqueRequest.Options.ASCENDING = "ascending"

Definition at line 122 of file AggregateUnique.cs.

◆ CHUNK_COLUMN_MAX_MEMORY

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

◆ CHUNK_MAX_MEMORY

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

◆ CHUNK_SIZE

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

◆ COLLECTION_NAME

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

Definition at line 99 of file AggregateUnique.cs.

◆ CREATE_TEMP_TABLE

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

◆ DESCENDING

const string kinetica.AggregateUniqueRequest.Options.DESCENDING = "descending"

Definition at line 123 of file AggregateUnique.cs.

◆ EXPRESSION

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

Optional filter expression to apply to the table.

Definition at line 103 of file AggregateUnique.cs.

◆ FALSE

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

Definition at line 88 of file AggregateUnique.cs.

◆ ORDER_BY

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

The default value is ''.

Definition at line 129 of file AggregateUnique.cs.

◆ RESULT_TABLE

const string kinetica.AggregateUniqueRequest.Options.RESULT_TABLE = "result_table"

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 column_name is an unrestricted-length string.

Definition at line 140 of file AggregateUnique.cs.

◆ RESULT_TABLE_FORCE_REPLICATED

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

◆ RESULT_TABLE_GENERATE_PK

const string kinetica.AggregateUniqueRequest.Options.RESULT_TABLE_GENERATE_PK = "result_table_generate_pk"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 188 of file AggregateUnique.cs.

◆ RESULT_TABLE_PERSIST

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

◆ SORT_ORDER

const string kinetica.AggregateUniqueRequest.Options.SORT_ORDER = "sort_order"

String indicating how the returned values should be sorted.

Supported values:

The default value is ASCENDING.

Definition at line 120 of file AggregateUnique.cs.

◆ TRUE

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

Definition at line 87 of file AggregateUnique.cs.

◆ TTL

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

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 193 of file AggregateUnique.cs.

◆ VIEW_ID

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

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

The default value is ''.

Definition at line 219 of file AggregateUnique.cs.

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

Kinetica/Protocol/AggregateUnique.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ASCENDING

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ CREATE_TEMP_TABLE

◆ DESCENDING

◆ EXPRESSION

◆ FALSE

◆ ORDER_BY

◆ RESULT_TABLE

◆ RESULT_TABLE_FORCE_REPLICATED

◆ RESULT_TABLE_GENERATE_PK

◆ RESULT_TABLE_PERSIST

◆ SORT_ORDER

◆ TRUE

◆ TTL

◆ VIEW_ID