Skip to main content

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

​
Static 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.
 
const string TRUE = “true”
 A boolean constant for the CreateTableRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the CreateTableRequest.Options options.
 
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 CreateTableRequest.table_name.
 
const string COLLECTION_NAME = “collection_name”
 [DEPRECATED–please specify the containing schema as part of CreateTableRequest.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.
 
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.
 
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 CreateTableRequest.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.
 
const string LOAD_VECTORS_POLICY = “load_vectors_policy”
 Set startup data loading scheme for the table.
 
const string ALWAYS = “always”
 Generate as much primary key index data as possible before accepting requests.
 
const string LAZY = “lazy”
 Generate the necessary primary key index data at start, and load the remainder lazily.
 
const string ON_DEMAND = “on_demand”
 Generate primary key index data as requests use it.
 
const string SYSTEM = “system”
 Generate primary key index data using the system-configured default.
 
const string BUILD_PK_INDEX_POLICY = “build_pk_index_policy”
 Set startup primary-key index generation scheme for the table.
 

​
Detailed Description

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

Optional parameters.

Definition at line 58 of file CreateTable.cs.

​
Member Data Documentation

​
◆ ALWAYS

const string kinetica.CreateTableRequest.Options.ALWAYS = “always”
 static

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

Definition at line 394 of file CreateTable.cs.

​
◆ BUILD_PK_INDEX_POLICY

const string kinetica.CreateTableRequest.Options.BUILD_PK_INDEX_POLICY = “build_pk_index_policy”
 static

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 443 of file CreateTable.cs.

​
◆ CHUNK_COLUMN_MAX_MEMORY

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

​
◆ CHUNK_MAX_MEMORY

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

​
◆ CHUNK_SIZE

const string kinetica.CreateTableRequest.Options.CHUNK_SIZE = “chunk_size”
 static

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

Definition at line 312 of file CreateTable.cs.

​
◆ COLLECTION_NAME

const string kinetica.CreateTableRequest.Options.COLLECTION_NAME = “collection_name”
 static

[DEPRECATED–please specify the containing schema as part of CreateTableRequest.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 122 of file CreateTable.cs.

​
◆ COMPRESSION_CODEC

const string kinetica.CreateTableRequest.Options.COMPRESSION_CODEC = “compression_codec”
 static

The default compression codec for this table’s columns.

Definition at line 354 of file CreateTable.cs.

​
◆ CREATE_TEMP_TABLE

const string kinetica.CreateTableRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”
 static

If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateTableRequest.table_name.

If IS_RESULT_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_TABLE_NAME. Supported values:

The default value is FALSE.

Definition at line 113 of file CreateTable.cs.

​
◆ FALSE

const string kinetica.CreateTableRequest.Options.FALSE = “false”
 static

A boolean constant for the CreateTableRequest.Options options.

Definition at line 87 of file CreateTable.cs.

​
◆ FOREIGN_KEYS

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

​
◆ FOREIGN_SHARD_KEY

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

​
◆ HASH

const string kinetica.CreateTableRequest.Options.HASH = “HASH”
 static

Use hash partitioning.

Definition at line 251 of file CreateTable.cs.

​
◆ INTERVAL

const string kinetica.CreateTableRequest.Options.INTERVAL = “INTERVAL”
 static

Use interval partitioning.

Definition at line 241 of file CreateTable.cs.

​
◆ IS_AUTOMATIC_PARTITION

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

The default value is FALSE.

Definition at line 303 of file CreateTable.cs.

​
◆ IS_COLLECTION

const string kinetica.CreateTableRequest.Options.IS_COLLECTION = “is_collection”
 static

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

Supported values:

The default value is FALSE.

Definition at line 142 of file CreateTable.cs.

​
◆ IS_REPLICATED

const string kinetica.CreateTableRequest.Options.IS_REPLICATED = “is_replicated”
 static

Affects the distribution scheme for the table’s data.

If TRUE and the given type 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 CreateTableRequest.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:

The default value is FALSE.

Definition at line 176 of file CreateTable.cs.

​
◆ IS_RESULT_TABLE

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

The default value is FALSE.

Definition at line 343 of file CreateTable.cs.

​
◆ LAZY

const string kinetica.CreateTableRequest.Options.LAZY = “lazy”
 static

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

Definition at line 398 of file CreateTable.cs.

​
◆ LIST

const string kinetica.CreateTableRequest.Options.LIST = “LIST”
 static

Use list partitioning.

Definition at line 246 of file CreateTable.cs.

​
◆ LOAD_VECTORS_POLICY

const string kinetica.CreateTableRequest.Options.LOAD_VECTORS_POLICY = “load_vectors_policy”
 static

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 390 of file CreateTable.cs.

​
◆ NO_ERROR_IF_EXISTS

const string kinetica.CreateTableRequest.Options.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 ID but a different type exists, it is still an error. Supported values:

The default value is FALSE.

Definition at line 79 of file CreateTable.cs.

​
◆ ON_DEMAND

const string kinetica.CreateTableRequest.Options.ON_DEMAND = “on_demand”
 static

Generate primary key index data as requests use it.

Definition at line 402 of file CreateTable.cs.

​
◆ PARTITION_DEFINITIONS

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

​
◆ PARTITION_KEYS

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

​
◆ PARTITION_TYPE

const string kinetica.CreateTableRequest.Options.PARTITION_TYPE = “partition_type”
 static

Partitioning scheme to use.

Supported values:

Definition at line 231 of file CreateTable.cs.

​
◆ RANGE

const string kinetica.CreateTableRequest.Options.RANGE = “RANGE”
 static

Use range partitioning.

Definition at line 236 of file CreateTable.cs.

​
◆ SERIES

const string kinetica.CreateTableRequest.Options.SERIES = “SERIES”
 static

Use series partitioning.

Definition at line 256 of file CreateTable.cs.

​
◆ STRATEGY_DEFINITION

const string kinetica.CreateTableRequest.Options.STRATEGY_DEFINITION = “strategy_definition”
 static

The tier strategy for the table and its columns.

Definition at line 348 of file CreateTable.cs.

​
◆ SYSTEM

const string kinetica.CreateTableRequest.Options.SYSTEM = “system”
 static

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

Definition at line 406 of file CreateTable.cs.

​
◆ TRUE

const string kinetica.CreateTableRequest.Options.TRUE = “true”
 static

A boolean constant for the CreateTableRequest.Options options.

Definition at line 83 of file CreateTable.cs.

​
◆ TTL

const string kinetica.CreateTableRequest.Options.TTL = “ttl”
 static

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

Definition at line 308 of file CreateTable.cs.

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