kinetica.CreateProjectionRequest.Options

A set of string constants for the parameter CreateProjectionRequest.options. More…

Static Public Attributes
const string	CREATE_TEMP_TABLE = “create_temp_table”
	If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateProjectionRequest.projection_name.

const string	TRUE = “true”
	A boolean constant for the CreateProjectionRequest.Options options.

const string	FALSE = “false”
	A boolean constant for the CreateProjectionRequest.Options options.

const string	COLLECTION_NAME = “collection_name”
	[DEPRECATED–please specify the containing schema for the projection as part of CreateProjectionRequest.projection_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the projection.

const string	EXPRESSION = “expression”
	An optional filter expression to be applied to the source table prior to the projection.

const string	IS_REPLICATED = “is_replicated”
	If TRUE then the projection will be replicated even if the source table is not.

const string	OFFSET = “offset”
	The number of initial results to skip (this can be useful for paging through the results).

const string	LIMIT = “limit”
	The number of records to keep.

const string	ORDER_BY = “order_by”
	Comma-separated list of the columns to be sorted by; e.g.

const string	CHUNK_SIZE = “chunk_size”
	Indicates the number of records per chunk to be used for this projection.

const string	CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
	Indicates the target maximum data size for each column in a chunk to be used for this projection.

const string	CHUNK_MAX_MEMORY = “chunk_max_memory”
	Indicates the target maximum data size for all columns in a chunk to be used for this projection.

const string	CREATE_INDEXES = “create_indexes”
	Comma-separated list of columns on which to create indexes on the projection.

const string	TTL = “ttl”
	Sets the TTL of the projection specified in CreateProjectionRequest.projection_name.

const string	SHARD_KEY = “shard_key”
	Comma-separated list of the columns to be sharded on; e.g.

const string	PERSIST = “persist”
	If TRUE, then the projection specified in CreateProjectionRequest.projection_name will be persisted and will not expire unless a TTL is specified.

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.

const string	RETAIN_PARTITIONS = “retain_partitions”
	Determines whether the created projection will retain the partitioning scheme from the source table.

const string	PARTITION_TYPE = “partition_type”
	Partitioning scheme to use.

const string	RANGE = “RANGE”
	Use range partitioning.

const string	INTERVAL = “INTERVAL”
	Use interval partitioning.

const string	LIST = “LIST”
	Use list partitioning.

const string	HASH = “HASH”
	Use hash partitioning.

const string	SERIES = “SERIES”
	Use series partitioning.

const string	PARTITION_KEYS = “partition_keys”
	Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS.

const string	PARTITION_DEFINITIONS = “partition_definitions”
	Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.

const string	IS_AUTOMATIC_PARTITION = “is_automatic_partition”
	If TRUE, a new partition will be created for values which don’t fall into an existing partition.

const string	VIEW_ID = “view_id”
	ID of view of which this projection is a member.

const string	STRATEGY_DEFINITION = “strategy_definition”
	The tier strategy for the table and its columns.

const string	COMPRESSION_CODEC = “compression_codec”
	The default compression codec for the projection’s columns.

const string	JOIN_WINDOW_FUNCTIONS = “join_window_functions”
	If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join_window_functions_threshold.

const string	JOIN_WINDOW_FUNCTIONS_THRESHOLD = “join_window_functions_threshold”
	If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together.

const string	QUALIFY_FILTER = “qualify_filter”
	An optional filter expression applied to the projection after window function evaluation, equivalent to a SQL QUALIFY clause.

Detailed Description

A set of string constants for the parameter CreateProjectionRequest.options.

Optional parameters.

Definition at line 48 of file CreateProjection.cs.

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.CreateProjectionRequest.Options.CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”

static

Indicates the target maximum data size for each column in a chunk to be used for this projection.

Definition at line 150 of file CreateProjection.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateProjectionRequest.Options.CHUNK_MAX_MEMORY = “chunk_max_memory”

static

Indicates the target maximum data size for all columns in a chunk to be used for this projection.

Definition at line 154 of file CreateProjection.cs.

◆ CHUNK_SIZE

const string kinetica.CreateProjectionRequest.Options.CHUNK_SIZE = “chunk_size”

static

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

Definition at line 146 of file CreateProjection.cs.

◆ COLLECTION_NAME

const string kinetica.CreateProjectionRequest.Options.COLLECTION_NAME = “collection_name”

static

[DEPRECATED–please specify the containing schema for the projection as part of CreateProjectionRequest.projection_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the projection.

If the schema is non-existent, it will be automatically created. The default value is ”.

Definition at line 96 of file CreateProjection.cs.

◆ COMPRESSION_CODEC

const string kinetica.CreateProjectionRequest.Options.COMPRESSION_CODEC = “compression_codec”

static

The default compression codec for the projection’s columns.

Definition at line 384 of file CreateProjection.cs.

◆ CREATE_INDEXES

const string kinetica.CreateProjectionRequest.Options.CREATE_INDEXES = “create_indexes”

static

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

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

◆ CREATE_TEMP_TABLE

const string kinetica.CreateProjectionRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”

static

If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateProjectionRequest.projection_name.

If PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_PROJECTION_NAME. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 78 of file CreateProjection.cs.

◆ EXPRESSION

const string kinetica.CreateProjectionRequest.Options.EXPRESSION = “expression”

static

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

The default value is ”.

Definition at line 103 of file CreateProjection.cs.

◆ FALSE

const string kinetica.CreateProjectionRequest.Options.FALSE = “false”

static

A boolean constant for the CreateProjectionRequest.Options options.

Definition at line 86 of file CreateProjection.cs.

◆ HASH

const string kinetica.CreateProjectionRequest.Options.HASH = “HASH”

static

Use hash partitioning.

Definition at line 314 of file CreateProjection.cs.

◆ INTERVAL

const string kinetica.CreateProjectionRequest.Options.INTERVAL = “INTERVAL”

static

Use interval partitioning.

Definition at line 304 of file CreateProjection.cs.

◆ IS_AUTOMATIC_PARTITION

const string kinetica.CreateProjectionRequest.Options.IS_AUTOMATIC_PARTITION = “is_automatic_partition”

static

If TRUE, a new partition will be created for values which don’t fall into an existing partition.

Currently only supported for list partitions. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 369 of file CreateProjection.cs.

◆ IS_REPLICATED

const string kinetica.CreateProjectionRequest.Options.IS_REPLICATED = “is_replicated”

static

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

◆ JOIN_WINDOW_FUNCTIONS

const string kinetica.CreateProjectionRequest.Options.JOIN_WINDOW_FUNCTIONS = “join_window_functions”

static

If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join_window_functions_threshold.

The default value is ‘true’.

Definition at line 391 of file CreateProjection.cs.

◆ JOIN_WINDOW_FUNCTIONS_THRESHOLD

const string kinetica.CreateProjectionRequest.Options.JOIN_WINDOW_FUNCTIONS_THRESHOLD = “join_window_functions_threshold”

static

If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together.

The default value is ”.

Definition at line 397 of file CreateProjection.cs.

◆ LIMIT

const string kinetica.CreateProjectionRequest.Options.LIMIT = “limit”

static

The number of records to keep.

The default value is ‘-9999’.

Definition at line 134 of file CreateProjection.cs.

◆ LIST

const string kinetica.CreateProjectionRequest.Options.LIST = “LIST”

static

Use list partitioning.

Definition at line 309 of file CreateProjection.cs.

◆ OFFSET

const string kinetica.CreateProjectionRequest.Options.OFFSET = “offset”

static

The number of initial results to skip (this can be useful for paging through the results).

The default value is ‘0’.

Definition at line 130 of file CreateProjection.cs.

◆ ORDER_BY

const string kinetica.CreateProjectionRequest.Options.ORDER_BY = “order_by”

static

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

‘timestamp asc, x desc’.

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

◆ PARTITION_DEFINITIONS

const string kinetica.CreateProjectionRequest.Options.PARTITION_DEFINITIONS = “partition_definitions”

static

Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.

See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.

Definition at line 344 of file CreateProjection.cs.

◆ PARTITION_KEYS

const string kinetica.CreateProjectionRequest.Options.PARTITION_KEYS = “partition_keys”

static

Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS.

Definition at line 326 of file CreateProjection.cs.

◆ PARTITION_TYPE

const string kinetica.CreateProjectionRequest.Options.PARTITION_TYPE = “partition_type”

static

Partitioning scheme to use.

Supported values:

Definition at line 294 of file CreateProjection.cs.

◆ PERSIST

const string kinetica.CreateProjectionRequest.Options.PERSIST = “persist”

static

If TRUE, then the projection specified in CreateProjectionRequest.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 205 of file CreateProjection.cs.

◆ PRESERVE_DICT_ENCODING

const string kinetica.CreateProjectionRequest.Options.PRESERVE_DICT_ENCODING = “preserve_dict_encoding”

static

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

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 227 of file CreateProjection.cs.

◆ QUALIFY_FILTER

const string kinetica.CreateProjectionRequest.Options.QUALIFY_FILTER = “qualify_filter”

static

An optional filter expression applied to the projection after window function evaluation, equivalent to a SQL QUALIFY clause.

May reference window function aliases as well as any other column in the projection. Rows for which the expression evaluates to false (or NULL) are removed from the projection. The default value is ”.

Definition at line 407 of file CreateProjection.cs.

◆ RANGE

const string kinetica.CreateProjectionRequest.Options.RANGE = “RANGE”

static

Use range partitioning.

Definition at line 299 of file CreateProjection.cs.

◆ RETAIN_PARTITIONS

const string kinetica.CreateProjectionRequest.Options.RETAIN_PARTITIONS = “retain_partitions”

static

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 247 of file CreateProjection.cs.

◆ SERIES

const string kinetica.CreateProjectionRequest.Options.SERIES = “SERIES”

static

Use series partitioning.

Definition at line 319 of file CreateProjection.cs.

◆ SHARD_KEY

const string kinetica.CreateProjectionRequest.Options.SHARD_KEY = “shard_key”

static

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

‘column1, column2’.

Definition at line 175 of file CreateProjection.cs.

◆ STRATEGY_DEFINITION

const string kinetica.CreateProjectionRequest.Options.STRATEGY_DEFINITION = “strategy_definition”

static

The tier strategy for the table and its columns.

Definition at line 378 of file CreateProjection.cs.

◆ TRUE

const string kinetica.CreateProjectionRequest.Options.TRUE = “true”

static

A boolean constant for the CreateProjectionRequest.Options options.

Definition at line 82 of file CreateProjection.cs.

◆ TTL

const string kinetica.CreateProjectionRequest.Options.TTL = “ttl”

static

Sets the TTL of the projection specified in CreateProjectionRequest.projection_name.

Definition at line 167 of file CreateProjection.cs.

◆ VIEW_ID

const string kinetica.CreateProjectionRequest.Options.VIEW_ID = “view_id”

static

ID of view of which this projection is a member.

The default value is ”.

Definition at line 373 of file CreateProjection.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateProjection.cs
Kinetica/Protocol/CreateProjection.cs

​ Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ CHUNK_COLUMN_MAX_MEMORY

​◆ CHUNK_MAX_MEMORY

​◆ CHUNK_SIZE

​◆ COLLECTION_NAME

​◆ COMPRESSION_CODEC

​◆ CREATE_INDEXES

​◆ CREATE_TEMP_TABLE

​◆ EXPRESSION

​◆ FALSE

​◆ HASH

​◆ INTERVAL

​◆ IS_AUTOMATIC_PARTITION

​◆ IS_REPLICATED

​◆ JOIN_WINDOW_FUNCTIONS

​◆ JOIN_WINDOW_FUNCTIONS_THRESHOLD

​◆ LIMIT

​◆ LIST

​◆ OFFSET

​◆ ORDER_BY

​◆ PARTITION_DEFINITIONS

​◆ PARTITION_KEYS

​◆ PARTITION_TYPE

​◆ PERSIST

​◆ PRESERVE_DICT_ENCODING

​◆ QUALIFY_FILTER

​◆ RANGE

​◆ RETAIN_PARTITIONS

​◆ SERIES

​◆ SHARD_KEY

​◆ STRATEGY_DEFINITION

​◆ TRUE

​◆ TTL

​◆ VIEW_ID

Static Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ COMPRESSION_CODEC

◆ CREATE_INDEXES

◆ CREATE_TEMP_TABLE

◆ EXPRESSION

◆ FALSE

◆ HASH

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ IS_REPLICATED

◆ JOIN_WINDOW_FUNCTIONS

◆ JOIN_WINDOW_FUNCTIONS_THRESHOLD

◆ LIMIT

◆ LIST

◆ OFFSET

◆ ORDER_BY

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ PERSIST

◆ PRESERVE_DICT_ENCODING

◆ QUALIFY_FILTER

◆ RANGE

◆ RETAIN_PARTITIONS

◆ SERIES

◆ SHARD_KEY

◆ STRATEGY_DEFINITION

◆ TRUE

◆ TTL

◆ VIEW_ID