Kinetica C# API  Version 7.1.10.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 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(string,IDictionary{string, string}) 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 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 VIEW_ID = "view_id"
 ID of view of which the result table will be a member. More...
 

Detailed Description

Optional parameters.

  • 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. 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.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of result_table and use /create/schema 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.
  • 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, 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 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 258 of file AggregateUnique.cs.

Member Data Documentation

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

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

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

[DEPRECATED–please specify the containing schema as part of result_table and use Kinetica.createSchema(string,IDictionary{string, string}) 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 292 of file AggregateUnique.cs.

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.

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

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

Definition at line 315 of file AggregateUnique.cs.

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

Optional filter expression to apply to the table.

Definition at line 296 of file AggregateUnique.cs.

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

Definition at line 283 of file AggregateUnique.cs.

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 326 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 364 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 382 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 346 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 313 of file AggregateUnique.cs.

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

Definition at line 282 of file AggregateUnique.cs.

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

Sets the TTL of the table specified in result_table.

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

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