Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateTableExternalRequest.CreateTableOptions Struct Reference

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

Public Attributes

const string TYPE_ID = "type_id"
 ID of a currently registered type. More...
 
const string NO_ERROR_IF_EXISTS = "no_error_if_exists"
 If TRUE, prevents an error from occurring if the table already exists and is of the given type. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string IS_REPLICATED = "is_replicated"
 Affects the distribution scheme for the table's data. More...
 
const string FOREIGN_KEYS = "foreign_keys"
 Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. More...
 
const string FOREIGN_SHARD_KEY = "foreign_shard_key"
 Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'. 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 TTL = "ttl"
 Sets the TTL of the table specified in table_name. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the number of records per chunk to be used for this table. 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 table. 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 table. More...
 
const string IS_RESULT_TABLE = "is_result_table"
 Indicates whether the table is a memory-only table. More...
 
const string STRATEGY_DEFINITION = "strategy_definition"
 The tier strategy for the table and its columns. More...
 

Detailed Description

A set of string constants for the parameter create_table_options.

Options from Kinetica.createTable, allowing the structure of the table to be defined independently of the data source

Definition at line 35 of file CreateTableExternal.cs.

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.CreateTableExternalRequest.CreateTableOptions.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 table.

Definition at line 217 of file CreateTableExternal.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateTableExternalRequest.CreateTableOptions.CHUNK_MAX_MEMORY = "chunk_max_memory"

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

Definition at line 221 of file CreateTableExternal.cs.

◆ CHUNK_SIZE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.CHUNK_SIZE = "chunk_size"

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

Definition at line 213 of file CreateTableExternal.cs.

◆ FALSE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FALSE = "false"

Definition at line 61 of file CreateTableExternal.cs.

◆ FOREIGN_KEYS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FOREIGN_KEYS = "foreign_keys"

Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.

Definition at line 88 of file CreateTableExternal.cs.

◆ FOREIGN_SHARD_KEY

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FOREIGN_SHARD_KEY = "foreign_shard_key"

Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.

Definition at line 93 of file CreateTableExternal.cs.

◆ HASH

const string kinetica.CreateTableExternalRequest.CreateTableOptions.HASH = "HASH"

Use hash partitioning.

Definition at line 156 of file CreateTableExternal.cs.

◆ INTERVAL

const string kinetica.CreateTableExternalRequest.CreateTableOptions.INTERVAL = "INTERVAL"

Use interval partitioning.

Definition at line 146 of file CreateTableExternal.cs.

◆ IS_AUTOMATIC_PARTITION

const string kinetica.CreateTableExternalRequest.CreateTableOptions.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:

The default value is FALSE.

Definition at line 204 of file CreateTableExternal.cs.

◆ IS_REPLICATED

const string kinetica.CreateTableExternalRequest.CreateTableOptions.IS_REPLICATED = "is_replicated"

Affects the distribution scheme for the table's data.

Supported values:

The default value is FALSE.

Definition at line 80 of file CreateTableExternal.cs.

◆ IS_RESULT_TABLE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.IS_RESULT_TABLE = "is_result_table"

Indicates whether the table is a memory-only table.

Supported values:

The default value is FALSE.

Definition at line 239 of file CreateTableExternal.cs.

◆ LIST

const string kinetica.CreateTableExternalRequest.CreateTableOptions.LIST = "LIST"

Use list partitioning.

Definition at line 151 of file CreateTableExternal.cs.

◆ NO_ERROR_IF_EXISTS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.NO_ERROR_IF_EXISTS = "no_error_if_exists"

If TRUE, prevents an error from occurring if the table already exists and is of the given type.

Supported values:

The default value is FALSE.

Definition at line 58 of file CreateTableExternal.cs.

◆ PARTITION_DEFINITIONS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.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 186 of file CreateTableExternal.cs.

◆ PARTITION_KEYS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.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 168 of file CreateTableExternal.cs.

◆ PARTITION_TYPE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.PARTITION_TYPE = "partition_type"

Partitioning scheme to use.

Supported values:

Definition at line 136 of file CreateTableExternal.cs.

◆ RANGE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.RANGE = "RANGE"

Use range partitioning.

Definition at line 141 of file CreateTableExternal.cs.

◆ SERIES

const string kinetica.CreateTableExternalRequest.CreateTableOptions.SERIES = "SERIES"

Use series partitioning.

Definition at line 161 of file CreateTableExternal.cs.

◆ STRATEGY_DEFINITION

const string kinetica.CreateTableExternalRequest.CreateTableOptions.STRATEGY_DEFINITION = "strategy_definition"

The tier strategy for the table and its columns.

Definition at line 244 of file CreateTableExternal.cs.

◆ TRUE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TRUE = "true"

Definition at line 60 of file CreateTableExternal.cs.

◆ TTL

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TTL = "ttl"

Sets the TTL of the table specified in table_name.

Definition at line 209 of file CreateTableExternal.cs.

◆ TYPE_ID

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TYPE_ID = "type_id"

ID of a currently registered type.

Definition at line 40 of file CreateTableExternal.cs.


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