Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.CreateProjectionRequest.Options Struct Reference

Optional parameters. 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(string,IDictionary{string, string}) 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 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...
 

Detailed Description

Optional parameters.

  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . 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: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of and use /create/schema 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 ''.
  • 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: The default value is FALSE.
  • OFFSET: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
  • LIMIT: The number of records to keep. The default value is '-9999'.
  • 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 ''.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. 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: 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. Supported values: The default value is TRUE.
  • RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is FALSE.
  • PARTITION_TYPE: Partitioning scheme to use. Supported values:
  • 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.
  • 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.
  • IS_AUTOMATIC_PARTITION: 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: The default value is FALSE.
  • VIEW_ID: ID of view of which this projection is a member. The default value is ''.
  • STRATEGY_DEFINITION: The tier strategy for the table and its columns.

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

Definition at line 346 of file CreateProjection.cs.

Member Data Documentation

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

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(string,IDictionary{string, string}) 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 379 of file CreateProjection.cs.

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

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.

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:

The default value is FALSE.

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

The default value is ''.

Definition at line 385 of file CreateProjection.cs.

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

Definition at line 370 of file CreateProjection.cs.

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

Use hash partitioning.

Definition at line 557 of file CreateProjection.cs.

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

Use interval partitioning.

Definition at line 547 of file CreateProjection.cs.

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.

Currently only supported for list partitions. Supported values:

The default value is FALSE.

Definition at line 603 of file CreateProjection.cs.

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:

The default value is FALSE.

Definition at line 402 of file CreateProjection.cs.

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

The number of records to keep.

The default value is '-9999'.

Definition at line 411 of file CreateProjection.cs.

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

Use list partitioning.

Definition at line 552 of file CreateProjection.cs.

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

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

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

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

Partitioning scheme to use.

Supported values:

Definition at line 537 of file CreateProjection.cs.

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

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:

The default value is TRUE.

Definition at line 478 of file CreateProjection.cs.

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

Use range partitioning.

Definition at line 542 of file CreateProjection.cs.

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:

The default value is FALSE.

Definition at line 495 of file CreateProjection.cs.

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

Use series partitioning.

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

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

The tier strategy for the table and its columns.

Definition at line 612 of file CreateProjection.cs.

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

Definition at line 369 of file CreateProjection.cs.

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

Sets the TTL of the projection specified in projection_name.

Definition at line 434 of file CreateProjection.cs.

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

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