Kinetica C# API  Version 6.1.0.0
Public Attributes | List of all members
kinetica.AggregateUniqueRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection 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 RESULT_TABLE = "result_table"
 The name of the table used to store the results. 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 TRUE = "true"
 
const string FALSE = "false"
 
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 chunk size to be used for the result table. More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if is a collection.
  • EXPRESSION: Optional filter expression to apply to the table.
  • SORT_ORDER: String indicating how the returned values should be sorted. Supported values: The default value is ASCENDING.
  • RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if is a collection or when is an unrestricted-length string.
  • 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.
  • RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option.
  • RESULT_TABLE_GENERATE_PK: If 'true' then set a primary key for the result table. Must be used in combination with the result_table option.
  • TTL: Sets the TTL of the table specified in result_table.
  • CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.


A set of string constants for the parameter options.

Definition at line 194 of file AggregateUnique.cs.

Member Data Documentation

◆ ASCENDING

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

Definition at line 225 of file AggregateUnique.cs.

◆ CHUNK_SIZE

const string kinetica.AggregateUniqueRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the chunk size to be used for the result table.

Must be used in combination with the result_table option.

Definition at line 278 of file AggregateUnique.cs.

◆ COLLECTION_NAME

const string kinetica.AggregateUniqueRequest.Options.COLLECTION_NAME = "collection_name"

Name of a collection which is to contain the table specified in result_table.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if table_name is a collection.

Definition at line 203 of file AggregateUnique.cs.

◆ DESCENDING

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

Definition at line 226 of file AggregateUnique.cs.

◆ EXPRESSION

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

Optional filter expression to apply to the table.

Definition at line 207 of file AggregateUnique.cs.

◆ FALSE

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

Definition at line 258 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.

If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if table_name is a collection or when column_name is an unrestricted-length string.

Definition at line 236 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).

Must be used in combination with the result_table option.

Definition at line 263 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.

Must be used in combination with the result_table option.

Definition at line 268 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.

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 256 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 224 of file AggregateUnique.cs.

◆ TRUE

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

Definition at line 257 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 273 of file AggregateUnique.cs.

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