Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 number of records per 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

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.
  • 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 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. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.
  • TTL: Sets the TTL of the table specified in result_table.
  • 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.
  • VIEW_ID: ID of view of which the result table will be a member. The default value is ''.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 219 of file AggregateUnique.cs.

Member Data Documentation

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

Definition at line 248 of file AggregateUnique.cs.

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

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.

Definition at line 226 of file AggregateUnique.cs.

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

Definition at line 249 of file AggregateUnique.cs.

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

Optional filter expression to apply to the table.

Definition at line 230 of file AggregateUnique.cs.

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

Definition at line 279 of file AggregateUnique.cs.

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

Definition at line 257 of file AggregateUnique.cs.

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. Supported values:

The default value is FALSE.

Definition at line 297 of file AggregateUnique.cs.

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. Supported values:

The default value is FALSE.

Definition at line 315 of file AggregateUnique.cs.

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

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

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

Definition at line 278 of file AggregateUnique.cs.

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

Sets the TTL of the table specified in result_table.

Definition at line 320 of file AggregateUnique.cs.

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

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