Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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', otherwise the table will be a top-level 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 as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string TTL = "ttl"
 Sets the TTL of the table specified in 'result_table'. More...
 

Detailed Description

Optional parameters.

  • collection_name Name of a collection which is to contain the table specified in 'result_table', otherwise the table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
  • expression Optional filter expression to apply to the table.
  • sort_order String indicating how the returned values should be sorted. Values: ascending, descending.
  • 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.
  • result_table_persist If true then the result table specified in result_table will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false.
  • ttl Sets the TTL of the table specified in 'result_table'. The value must be the desired TTL in minutes.


A set of string constants for the parameter <member name="options">.

Definition at line 122 of file AggregateUnique.cs.

Member Data Documentation

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

Definition at line 140 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', otherwise the table will be a top-level table.

If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.

Definition at line 130 of file AggregateUnique.cs.

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

Definition at line 141 of file AggregateUnique.cs.

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

Optional filter expression to apply to the table.

Definition at line 134 of file AggregateUnique.cs.

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

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

Definition at line 148 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 as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations).

If false (the default) then the result table will be a read-only, memory-only temporary table. Values: true, false.

Definition at line 158 of file AggregateUnique.cs.

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

String indicating how the returned values should be sorted.

Values: ascending, descending.

Definition at line 139 of file AggregateUnique.cs.

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

Definition at line 159 of file AggregateUnique.cs.

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

Sets the TTL of the table specified in 'result_table'.

The value must be the desired TTL in minutes.

Definition at line 164 of file AggregateUnique.cs.


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