kinetica.CreateTableExternalRequest.CreateTableOptions

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

Static Public Attributes
const string	TYPE_ID = “type_id”
	ID of a currently registered type.

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.

const string	TRUE = “true”
	A boolean constant for the CreateTableExternalRequest.CreateTableOptions options.

const string	FALSE = “false”
	A boolean constant for the CreateTableExternalRequest.CreateTableOptions options.

const string	IS_REPLICATED = “is_replicated”
	Affects the distribution scheme for the table’s data.

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]’.

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)’.

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	TTL = “ttl”
	Sets the TTL of the table specified in CreateTableExternalRequest.table_name.

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

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.

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.

const string	IS_RESULT_TABLE = “is_result_table”
	Indicates whether the table is a memory-only table.

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 this table’s columns.

Detailed Description

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

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

Definition at line 34 of file CreateTableExternal.cs.

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

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

Definition at line 256 of file CreateTableExternal.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateTableExternalRequest.CreateTableOptions.CHUNK_MAX_MEMORY = “chunk_max_memory”

static

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

Definition at line 260 of file CreateTableExternal.cs.

◆ CHUNK_SIZE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.CHUNK_SIZE = “chunk_size”

static

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

Definition at line 252 of file CreateTableExternal.cs.

◆ COMPRESSION_CODEC

const string kinetica.CreateTableExternalRequest.CreateTableOptions.COMPRESSION_CODEC = “compression_codec”

static

The default compression codec for this table’s columns.

Definition at line 296 of file CreateTableExternal.cs.

◆ FALSE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FALSE = “false”

static

A boolean constant for the CreateTableExternalRequest.CreateTableOptions options.

Definition at line 72 of file CreateTableExternal.cs.

◆ FOREIGN_KEYS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FOREIGN_KEYS = “foreign_keys”

static

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 117 of file CreateTableExternal.cs.

◆ FOREIGN_SHARD_KEY

const string kinetica.CreateTableExternalRequest.CreateTableOptions.FOREIGN_SHARD_KEY = “foreign_shard_key”

static

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

Definition at line 121 of file CreateTableExternal.cs.

◆ HASH

const string kinetica.CreateTableExternalRequest.CreateTableOptions.HASH = “HASH”

static

Use hash partitioning.

Definition at line 188 of file CreateTableExternal.cs.

◆ INTERVAL

const string kinetica.CreateTableExternalRequest.CreateTableOptions.INTERVAL = “INTERVAL”

static

Use interval partitioning.

Definition at line 178 of file CreateTableExternal.cs.

◆ IS_AUTOMATIC_PARTITION

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

◆ IS_REPLICATED

const string kinetica.CreateTableExternalRequest.CreateTableOptions.IS_REPLICATED = “is_replicated”

static

Affects the distribution scheme for the table’s data.

If TRUE and the given table has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given TYPE_ID, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 110 of file CreateTableExternal.cs.

◆ IS_RESULT_TABLE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.IS_RESULT_TABLE = “is_result_table”

static

Indicates whether the table is a memory-only table.

A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 285 of file CreateTableExternal.cs.

◆ LIST

const string kinetica.CreateTableExternalRequest.CreateTableOptions.LIST = “LIST”

static

Use list partitioning.

Definition at line 183 of file CreateTableExternal.cs.

◆ NO_ERROR_IF_EXISTS

const string kinetica.CreateTableExternalRequest.CreateTableOptions.NO_ERROR_IF_EXISTS = “no_error_if_exists”

static

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

If a table with the same name but a different type exists, it is still an error. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 62 of file CreateTableExternal.cs.

◆ PARTITION_DEFINITIONS

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

◆ PARTITION_KEYS

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

◆ PARTITION_TYPE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.PARTITION_TYPE = “partition_type”

static

Partitioning scheme to use.

Supported values:

Definition at line 168 of file CreateTableExternal.cs.

◆ RANGE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.RANGE = “RANGE”

static

Use range partitioning.

Definition at line 173 of file CreateTableExternal.cs.

◆ SERIES

const string kinetica.CreateTableExternalRequest.CreateTableOptions.SERIES = “SERIES”

static

Use series partitioning.

Definition at line 193 of file CreateTableExternal.cs.

◆ STRATEGY_DEFINITION

const string kinetica.CreateTableExternalRequest.CreateTableOptions.STRATEGY_DEFINITION = “strategy_definition”

static

The tier strategy for the table and its columns.

Definition at line 290 of file CreateTableExternal.cs.

◆ TRUE

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TRUE = “true”

static

A boolean constant for the CreateTableExternalRequest.CreateTableOptions options.

Definition at line 67 of file CreateTableExternal.cs.

◆ TTL

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TTL = “ttl”

static

Sets the TTL of the table specified in CreateTableExternalRequest.table_name.

Definition at line 248 of file CreateTableExternal.cs.

◆ TYPE_ID

const string kinetica.CreateTableExternalRequest.CreateTableOptions.TYPE_ID = “type_id”

static

ID of a currently registered type.

Definition at line 38 of file CreateTableExternal.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/CreateTableExternal.cs
Kinetica/Protocol/CreateTableExternal.cs

​ Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ CHUNK_COLUMN_MAX_MEMORY

​◆ CHUNK_MAX_MEMORY

​◆ CHUNK_SIZE

​◆ COMPRESSION_CODEC

​◆ FALSE

​◆ FOREIGN_KEYS

​◆ FOREIGN_SHARD_KEY

​◆ HASH

​◆ INTERVAL

​◆ IS_AUTOMATIC_PARTITION

​◆ IS_REPLICATED

​◆ IS_RESULT_TABLE

​◆ LIST

​◆ NO_ERROR_IF_EXISTS

​◆ PARTITION_DEFINITIONS

​◆ PARTITION_KEYS

​◆ PARTITION_TYPE

​◆ RANGE

​◆ SERIES

​◆ STRATEGY_DEFINITION

​◆ TRUE

​◆ TTL

​◆ TYPE_ID

Static Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COMPRESSION_CODEC

◆ FALSE

◆ FOREIGN_KEYS

◆ FOREIGN_SHARD_KEY

◆ HASH

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ IS_REPLICATED

◆ IS_RESULT_TABLE

◆ LIST

◆ NO_ERROR_IF_EXISTS

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ RANGE

◆ SERIES

◆ STRATEGY_DEFINITION

◆ TRUE

◆ TTL

◆ TYPE_ID