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

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

const string	TRUE = "true"

const string	FALSE = "false"

const string	COLLECTION_NAME = "collection_name"
	[DEPRECATED–please specify the containing schema for the projection as part of projection_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the projection. 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	OFFSET = "offset"
	The number of initial results to skip (this can be useful for paging through the results). 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	CHUNK_SIZE = "chunk_size"
	Indicates the number of records per chunk to be used for this projection. More...

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

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. 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	PARTITION_TYPE = "partition_type"
	Partitioning scheme to use. More...

const string	RANGE = "RANGE"
	Use range partitioning. More...

const string	INTERVAL = "INTERVAL"
	Use interval partitioning. More...

const string	LIST = "LIST"
	Use list partitioning. More...

const string	HASH = "HASH"
	Use hash partitioning. More...

const string	SERIES = "SERIES"
	Use series partitioning. More...

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

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

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

const string	VIEW_ID = "view_id"
	ID of view of which this projection is a member. More...

const string	STRATEGY_DEFINITION = "strategy_definition"
	The tier strategy for the table and its columns. More...

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

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

Detailed Description

A set of string constants for the parameter 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"

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

Definition at line 126 of file CreateProjection.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateProjectionRequest.Options.CHUNK_MAX_MEMORY = "chunk_max_memory"

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

Definition at line 130 of file CreateProjection.cs.

◆ CHUNK_SIZE

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

◆ COLLECTION_NAME

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

[DEPRECATED–please specify the containing schema for the projection as part of 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 78 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 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 138 of file CreateProjection.cs.

◆ CREATE_TEMP_TABLE

const string kinetica.CreateProjectionRequest.Options.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 projection_name.

Supported values:

TRUE
FALSE

The default value is FALSE.

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

◆ FALSE

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

Definition at line 67 of file CreateProjection.cs.

◆ HASH

const string kinetica.CreateProjectionRequest.Options.HASH = "HASH"

Use hash partitioning.

Definition at line 257 of file CreateProjection.cs.

◆ INTERVAL

const string kinetica.CreateProjectionRequest.Options.INTERVAL = "INTERVAL"

Use interval partitioning.

Definition at line 247 of file CreateProjection.cs.

◆ IS_AUTOMATIC_PARTITION

const string kinetica.CreateProjectionRequest.Options.IS_AUTOMATIC_PARTITION = "is_automatic_partition"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

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

◆ JOIN_WINDOW_FUNCTIONS

const string kinetica.CreateProjectionRequest.Options.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.

The default value is 'true'.

Definition at line 319 of file CreateProjection.cs.

◆ JOIN_WINDOW_FUNCTIONS_THRESHOLD

const string kinetica.CreateProjectionRequest.Options.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.

The default value is ''.

Definition at line 325 of file CreateProjection.cs.

◆ LIMIT

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

The number of records to keep.

The default value is '-9999'.

Definition at line 110 of file CreateProjection.cs.

◆ LIST

const string kinetica.CreateProjectionRequest.Options.LIST = "LIST"

Use list partitioning.

Definition at line 252 of file CreateProjection.cs.

◆ OFFSET

const string kinetica.CreateProjectionRequest.Options.OFFSET = "offset"

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

The default value is '0'.

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

◆ PARTITION_DEFINITIONS

const string kinetica.CreateProjectionRequest.Options.PARTITION_DEFINITIONS = "partition_definitions"

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

◆ PARTITION_KEYS

const string kinetica.CreateProjectionRequest.Options.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.

Definition at line 269 of file CreateProjection.cs.

◆ PARTITION_TYPE

const string kinetica.CreateProjectionRequest.Options.PARTITION_TYPE = "partition_type"

Partitioning scheme to use.

Supported values:

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

Supported values:

TRUE
FALSE

The default value is FALSE.

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

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 184 of file CreateProjection.cs.

◆ RANGE

const string kinetica.CreateProjectionRequest.Options.RANGE = "RANGE"

Use range partitioning.

Definition at line 242 of file CreateProjection.cs.

◆ RETAIN_PARTITIONS

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:

TRUE
FALSE

The default value is FALSE.

Definition at line 199 of file CreateProjection.cs.

◆ SERIES

const string kinetica.CreateProjectionRequest.Options.SERIES = "SERIES"

Use series partitioning.

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

◆ STRATEGY_DEFINITION

const string kinetica.CreateProjectionRequest.Options.STRATEGY_DEFINITION = "strategy_definition"

The tier strategy for the table and its columns.

Definition at line 312 of file CreateProjection.cs.

◆ TRUE

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

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

◆ VIEW_ID

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 307 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_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ 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

◆ RANGE

◆ RETAIN_PARTITIONS

◆ SERIES

◆ SHARD_KEY

◆ STRATEGY_DEFINITION

◆ TRUE

◆ TTL

◆ VIEW_ID