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.CreateProjectionRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection to which the projection is to be assigned as a child. More...
 
const string EXPRESSION = "expression"
 An optional filter expression to be applied to the source table prior to the projection. More...
 
const string IS_REPLICATED = "is_replicated"
 If true then the projection will be replicated even if the source table is not. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string LIMIT = "limit"
 The number of records to keep. More...
 
const string ORDER_BY = "order_by"
 Comma-separated list of the columns to be sorted by; e.g. More...
 
const string MATERIALIZE_ON_GPU = "materialize_on_gpu"
 No longer used. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the number of records per chunk to be used for this projection. More...
 
const string CREATE_INDEXES = "create_indexes"
 Comma-separated list of columns on which to create indexes on the projection. More...
 
const string TTL = "ttl"
 Sets the TTL of the projection specified in projection_name. More...
 
const string SHARD_KEY = "shard_key"
 Comma-separated list of the columns to be sharded on; e.g. More...
 
const string PERSIST = "persist"
 If true, then the projection specified in projection_name will be persisted and will not expire unless a ttl is specified. More...
 
const string PRESERVE_DICT_ENCODING = "preserve_dict_encoding"
 If true, then columns that were dict encoded in the source table will be dict encoded in the projection. More...
 
const string RETAIN_PARTITIONS = "retain_partitions"
 Determines whether the created projection will retain the partitioning scheme from the source table. More...
 
const string VIEW_ID = "view_id"
 ID of view of which this projection is a member. More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. The default value is ''.
  • EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
  • IS_REPLICATED: If true then the projection will be replicated even if the source table is not. Supported values: The default value is FALSE.
  • LIMIT: The number of records to keep. The default value is ''.
  • 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 . If any alias is given for any column name, the alias must be used, rather than the original column name. 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.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
  • TTL: Sets the TTL of the projection specified in .
  • SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
  • PERSIST: If true, then the projection specified in will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is FALSE.
  • PRESERVE_DICT_ENCODING: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: The default value is TRUE.
  • RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is FALSE.
  • VIEW_ID: ID of view of which this projection is 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 234 of file CreateProjection.cs.

Member Data Documentation

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

Indicates the number of records per chunk to be used for this projection.

Definition at line 306 of file CreateProjection.cs.

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

Name of a collection to which the projection is to be assigned as a child.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. The default value is ''.

Definition at line 243 of file CreateProjection.cs.

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

Comma-separated list of columns on which to create indexes on the projection.

The columns specified must be present in 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 313 of file CreateProjection.cs.

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

An optional filter expression to be applied to the source table prior to the projection.

The default value is ''.

Definition at line 249 of file CreateProjection.cs.

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

Definition at line 268 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.Options.IS_REPLICATED = "is_replicated"

If true then the projection will be replicated even if the source table is not.

Supported values:

The default value is FALSE.

Definition at line 266 of file CreateProjection.cs.

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

The number of records to keep.

The default value is ''.

Definition at line 272 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.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 302 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.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 column_names. 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 279 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.Options.PERSIST = "persist"

If true, then the projection specified in projection_name will be persisted and will not expire unless a ttl is specified.

If false, then the projection 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 345 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.Options.PRESERVE_DICT_ENCODING = "preserve_dict_encoding"

If true, then columns that were dict encoded in the source table will be dict encoded in the projection.

Supported values:

The default value is TRUE.

Definition at line 362 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.Options.RETAIN_PARTITIONS = "retain_partitions"

Determines whether the created projection will retain the partitioning scheme from the source table.

Supported values:

The default value is FALSE.

Definition at line 379 of file CreateProjection.cs.

const string kinetica.CreateProjectionRequest.Options.SHARD_KEY = "shard_key"

Comma-separated list of the columns to be sharded on; e.g.

'column1, column2'. The columns specified must be present in column_names. 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 325 of file CreateProjection.cs.

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

Definition at line 267 of file CreateProjection.cs.

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

Sets the TTL of the projection specified in projection_name.

Definition at line 318 of file CreateProjection.cs.

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

ID of view of which this projection is a member.

The default value is ''.

Definition at line 383 of file CreateProjection.cs.

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