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

Public Attributes
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	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 table_name. More...

const string	COLLECTION_NAME = "collection_name"
	[DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. More...

const string	IS_COLLECTION = "is_collection"
	[DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. More...

const string	DISALLOW_HOMOGENEOUS_TABLES = "disallow_homogeneous_tables"
	No longer supported; value will be ignored. More...

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

const string	LOAD_VECTORS_POLICY = "load_vectors_policy"
	Set startup data loading scheme for the table. More...

const string	ALWAYS = "always"
	Generate as much primary key index data as possible before accepting requests. More...

const string	LAZY = "lazy"
	Generate the necessary primary key index data at start, and load the remainder lazily. More...

const string	ON_DEMAND = "on_demand"
	Generate primary key index data as requests use it. More...

const string	SYSTEM = "system"
	Generate primary key index data using the system-configured default. More...

const string	BUILD_PK_INDEX_POLICY = "build_pk_index_policy"
	Set startup primary-key index generation scheme for the table. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 32 of file CreateTable.cs.

Member Data Documentation

◆ ALWAYS

const string kinetica.CreateTableRequest.Options.ALWAYS = "always"

Generate as much primary key index data as possible before accepting requests.

Definition at line 312 of file CreateTable.cs.

◆ BUILD_PK_INDEX_POLICY

const string kinetica.CreateTableRequest.Options.BUILD_PK_INDEX_POLICY = "build_pk_index_policy"

Set startup primary-key index generation scheme for the table.

Supported values:

ALWAYS: Generate as much primary key index data as possible before accepting requests.
LAZY: Generate the necessary primary key index data at start, and load the remainder lazily.
ON_DEMAND: Generate primary key index data as requests use it.
SYSTEM: Generate primary key index data using the system-configured default.

The default value is SYSTEM.

Definition at line 355 of file CreateTable.cs.

◆ CHUNK_COLUMN_MAX_MEMORY

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

Definition at line 253 of file CreateTable.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateTableRequest.Options.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 257 of file CreateTable.cs.

◆ CHUNK_SIZE

const string kinetica.CreateTableRequest.Options.CHUNK_SIZE = "chunk_size"

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

Definition at line 249 of file CreateTable.cs.

◆ COLLECTION_NAME

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

[DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table.

If the schema is non-existent, it will be automatically created.

Definition at line 76 of file CreateTable.cs.

◆ CREATE_TEMP_TABLE

const string kinetica.CreateTableRequest.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 table_name.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 67 of file CreateTable.cs.

◆ DISALLOW_HOMOGENEOUS_TABLES

const string kinetica.CreateTableRequest.Options.DISALLOW_HOMOGENEOUS_TABLES = "disallow_homogeneous_tables"

No longer supported; value will be ignored.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 107 of file CreateTable.cs.

◆ FALSE

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

Definition at line 51 of file CreateTable.cs.

◆ FOREIGN_KEYS

const string kinetica.CreateTableRequest.Options.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 132 of file CreateTable.cs.

◆ FOREIGN_SHARD_KEY

const string kinetica.CreateTableRequest.Options.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 137 of file CreateTable.cs.

◆ HASH

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

Use hash partitioning.

Definition at line 195 of file CreateTable.cs.

◆ INTERVAL

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

Use interval partitioning.

Definition at line 185 of file CreateTable.cs.

◆ IS_AUTOMATIC_PARTITION

const string kinetica.CreateTableRequest.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 240 of file CreateTable.cs.

◆ IS_COLLECTION

const string kinetica.CreateTableRequest.Options.IS_COLLECTION = "is_collection"

[DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create a schema instead of a table.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 93 of file CreateTable.cs.

◆ IS_REPLICATED

const string kinetica.CreateTableRequest.Options.IS_REPLICATED = "is_replicated"

Affects the distribution scheme for the table's data.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 124 of file CreateTable.cs.

◆ IS_RESULT_TABLE

const string kinetica.CreateTableRequest.Options.IS_RESULT_TABLE = "is_result_table"

Indicates whether the table is a memory-only table.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 273 of file CreateTable.cs.

◆ LAZY

const string kinetica.CreateTableRequest.Options.LAZY = "lazy"

Generate the necessary primary key index data at start, and load the remainder lazily.

Definition at line 316 of file CreateTable.cs.

◆ LIST

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

Use list partitioning.

Definition at line 190 of file CreateTable.cs.

◆ LOAD_VECTORS_POLICY

const string kinetica.CreateTableRequest.Options.LOAD_VECTORS_POLICY = "load_vectors_policy"

Set startup data loading scheme for the table.

Supported values:

ALWAYS: Load as much vector data as possible into memory before accepting requests.
LAZY: Load the necessary vector data at start, and load the remainder lazily.
ON_DEMAND: Load vector data as requests use it.
SYSTEM: Load vector data using the system-configured default.

The default value is SYSTEM.

Definition at line 308 of file CreateTable.cs.

◆ NO_ERROR_IF_EXISTS

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

TRUE
FALSE

The default value is FALSE.

Definition at line 48 of file CreateTable.cs.

◆ ON_DEMAND

const string kinetica.CreateTableRequest.Options.ON_DEMAND = "on_demand"

Generate primary key index data as requests use it.

Definition at line 320 of file CreateTable.cs.

◆ PARTITION_DEFINITIONS

const string kinetica.CreateTableRequest.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 224 of file CreateTable.cs.

◆ PARTITION_KEYS

const string kinetica.CreateTableRequest.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 207 of file CreateTable.cs.

◆ PARTITION_TYPE

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

Partitioning scheme to use.

Supported values:

Definition at line 175 of file CreateTable.cs.

◆ RANGE

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

Use range partitioning.

Definition at line 180 of file CreateTable.cs.

◆ SERIES

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

Use series partitioning.

Definition at line 200 of file CreateTable.cs.

◆ STRATEGY_DEFINITION

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

The tier strategy for the table and its columns.

Definition at line 278 of file CreateTable.cs.

◆ SYSTEM

const string kinetica.CreateTableRequest.Options.SYSTEM = "system"

Generate primary key index data using the system-configured default.

Definition at line 324 of file CreateTable.cs.

◆ TRUE

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

Definition at line 50 of file CreateTable.cs.

◆ TTL

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

Sets the TTL of the table specified in table_name.

Definition at line 245 of file CreateTable.cs.

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

Kinetica/Protocol/CreateTable.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ALWAYS

◆ BUILD_PK_INDEX_POLICY

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ CREATE_TEMP_TABLE

◆ DISALLOW_HOMOGENEOUS_TABLES

◆ FALSE

◆ FOREIGN_KEYS

◆ FOREIGN_SHARD_KEY

◆ HASH

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ IS_COLLECTION

◆ IS_REPLICATED

◆ IS_RESULT_TABLE

◆ LAZY

◆ LIST

◆ LOAD_VECTORS_POLICY

◆ NO_ERROR_IF_EXISTS

◆ ON_DEMAND

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ RANGE

◆ SERIES

◆ STRATEGY_DEFINITION

◆ SYSTEM

◆ TRUE

◆ TTL