Kinetica C# API  Version 6.1.0.0
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 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"
 If true then the columns of the projection will be cached on the GPU. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the chunk size to be used for this table. 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...
 

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.
  • EXPRESSION: An optional filter expression to be applied to the source table prior to the projection.
  • LIMIT: The number of records to keep.
  • 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.
  • MATERIALIZE_ON_GPU: If true then the columns of the projection will be cached on the GPU. Supported values: The default value is FALSE.
  • CHUNK_SIZE: Indicates the chunk size to be used for this table.
  • 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.
  • 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.


A set of string constants for the parameter options.

Definition at line 153 of file CreateProjection.cs.

Member Data Documentation

◆ CHUNK_SIZE

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

Indicates the chunk size to be used for this table.

Definition at line 201 of file CreateProjection.cs.

◆ COLLECTION_NAME

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.

Definition at line 162 of file CreateProjection.cs.

◆ EXPRESSION

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

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

Definition at line 168 of file CreateProjection.cs.

◆ FALSE

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

Definition at line 197 of file CreateProjection.cs.

◆ LIMIT

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

The number of records to keep.

Definition at line 171 of file CreateProjection.cs.

◆ MATERIALIZE_ON_GPU

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

If true then the columns of the projection will be cached on the GPU.

Supported values:

The default value is FALSE.

Definition at line 195 of file CreateProjection.cs.

◆ ORDER_BY

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.

Definition at line 178 of file CreateProjection.cs.

◆ PERSIST

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 233 of file CreateProjection.cs.

◆ SHARD_KEY

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.

Definition at line 213 of file CreateProjection.cs.

◆ TRUE

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

Definition at line 196 of file CreateProjection.cs.

◆ TTL

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

Sets the TTL of the projection specified in projection_name.

Definition at line 206 of file CreateProjection.cs.


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