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.AggregateUnpivotRequest.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 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 EXPRESSION = "expression"
 Filter expression to apply to the table prior to unpivot processing. More...
 
const string ORDER_BY = "order_by"
 Comma-separated list of the columns to be sorted by; e.g. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the number of records per chunk to be used for the result table. More...
 
const string LIMIT = "limit"
 The number of records to keep. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in result_table. More...
 
const string VIEW_ID = "view_id"
 view this result table is part of. More...
 
const string MATERIALIZE_ON_GPU = "materialize_on_gpu"
 No longer used. More...
 
const string CREATE_INDEXES = "create_indexes"
 Comma-separated list of columns on which to create indexes on the table specified in result_table. More...
 
const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated"
 Force the result table to be replicated (ignores any sharding). 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.
  • RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response.
  • 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.
  • EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
  • ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  • 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.
  • LIMIT: The number of records to keep. The default value is ''.
  • TTL: Sets the TTL of the table specified in result_table.
  • VIEW_ID: view this result table is part of. The default value is ''.
  • MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values: The default value is FALSE.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
  • 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.

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

Definition at line 209 of file AggregateUnpivot.cs.

Member Data Documentation

const string kinetica.AggregateUnpivotRequest.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 260 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.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 216 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.Options.CREATE_INDEXES = "create_indexes"

Comma-separated list of columns on which to create indexes on the table specified in result_table.

The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.

Definition at line 303 of file AggregateUnpivot.cs.

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

Filter expression to apply to the table prior to unpivot processing.

Definition at line 248 of file AggregateUnpivot.cs.

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

Definition at line 244 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.Options.LIMIT = "limit"

The number of records to keep.

The default value is ''.

Definition at line 264 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.Options.MATERIALIZE_ON_GPU = "materialize_on_gpu"

No longer used.

See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:

The default value is FALSE.

Definition at line 296 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.Options.ORDER_BY = "order_by"

Comma-separated list of the columns to be sorted by; e.g.

'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.

Definition at line 255 of file AggregateUnpivot.cs.

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

The name of the table used to store the results.

Has the same naming restrictions as tables. If present, no results are returned in the response.

Definition at line 222 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.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 321 of file AggregateUnpivot.cs.

const string kinetica.AggregateUnpivotRequest.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 242 of file AggregateUnpivot.cs.

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

Definition at line 243 of file AggregateUnpivot.cs.

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

Sets the TTL of the table specified in result_table.

Definition at line 269 of file AggregateUnpivot.cs.

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

view this result table is part of.

The default value is ''.

Definition at line 273 of file AggregateUnpivot.cs.

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