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"
	If true then the columns of the projection will be cached on the GPU. More...

const string	CHUNK_SIZE = "chunk_size"
	Indicates the chunk size to be used for this table. More...

const string	CREATE_INDEXES = "create_indexes"
	Comma-separated list of columns on which to create indexes on the output 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...

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 table. More...

const string	VIEW_ID = "view_id"
	view this projection is part of. 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:
- TRUE
- FALSE
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: If true then the columns of the projection will be cached on the GPU. Supported values:
- TRUE
- FALSE
The default value is FALSE.
CHUNK_SIZE: Indicates the chunk size to be used for this table.
CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. 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:
- TRUE
- FALSE
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 table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
VIEW_ID: view this projection is part of. The default value is ''.

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

Definition at line 202 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 268 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. The default value is ''.

Definition at line 211 of file CreateProjection.cs.

◆ CREATE_INDEXES

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

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

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 275 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.

The default value is ''.

Definition at line 217 of file CreateProjection.cs.

◆ FALSE

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

Definition at line 236 of file CreateProjection.cs.

◆ IS_REPLICATED

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:

TRUE
FALSE

The default value is FALSE.

Definition at line 234 of file CreateProjection.cs.

◆ LIMIT

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

The number of records to keep.

The default value is ''.

Definition at line 240 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:

TRUE
FALSE

The default value is FALSE.

Definition at line 264 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. The default value is ''.

Definition at line 247 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:

TRUE
FALSE

The default value is FALSE.

Definition at line 307 of file CreateProjection.cs.

◆ PRESERVE_DICT_ENCODING

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 table.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 324 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. The default value is ''.

Definition at line 287 of file CreateProjection.cs.

◆ TRUE

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

Definition at line 235 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 280 of file CreateProjection.cs.

◆ VIEW_ID

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

view this projection is part of.

The default value is ''.

Definition at line 328 of file CreateProjection.cs.

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

Kinetica/Protocol/CreateProjection.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ CREATE_INDEXES

◆ EXPRESSION

◆ FALSE

◆ IS_REPLICATED

◆ LIMIT

◆ MATERIALIZE_ON_GPU

◆ ORDER_BY

◆ PERSIST

◆ PRESERVE_DICT_ENCODING

◆ SHARD_KEY

◆ TRUE

◆ TTL

◆ VIEW_ID