Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 TTL = "ttl"
 Sets the TTL of the table, view, or collection specified in <member name="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 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...
 

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.
  • 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. Values: true, false.
  • ttl Sets the TTL of the table, view, or collection specified in . The value must be the desired TTL in minutes.
  • 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 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 then the projection will be a read-only, memory-only temporary table. Values: true, false.


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

Definition at line 112 of file CreateProjection.cs.

Member Data Documentation

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.

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

Definition at line 127 of file CreateProjection.cs.

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

Definition at line 144 of file CreateProjection.cs.

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

The number of records to keep.

Definition at line 130 of file CreateProjection.cs.

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.

Values: true, false.

Definition at line 142 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 <member name="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 137 of file CreateProjection.cs.

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

If true then the projection 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 then the projection will be a read-only, memory-only temporary table. Values: true, false.

Definition at line 165 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 <member name="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 156 of file CreateProjection.cs.

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

Definition at line 143 of file CreateProjection.cs.

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

Sets the TTL of the table, view, or collection specified in <member name="projection_name">.

The value must be the desired TTL in minutes.

Definition at line 149 of file CreateProjection.cs.


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