> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CreateTableRequest.Options > kinetica.CreateTableRequest.Options — Kinetica C# API

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 file:
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.