Optional parameters. 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	COLLECTION_NAME = "collection_name"
	Name of a collection which is to contain the newly created table. More...

const string	IS_COLLECTION = "is_collection"
	Indicates whether the new table to be created will be a collection. More...

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

const string	IS_REPLICATED = "is_replicated"
	For a table, 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	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"
	For a table, 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	IS_RESULT_TABLE = "is_result_table"
	For a table, indicates whether the table is an in-memory table. More...

const string	STRATEGY_DEFINITION = "strategy_definition"
	The tier strategy for the table and its columns. More...

Detailed Description

Optional parameters.

NO_ERROR_IF_EXISTS: 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:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
IS_COLLECTION: Indicates whether the new table to be created will be a collection. Supported values:
- TRUE
- FALSE
The default value is FALSE.
DISALLOW_HOMOGENEOUS_TABLES: No longer supported; value will be ignored. Supported values:
- TRUE
- FALSE
The default value is FALSE.
IS_REPLICATED: For a table, 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 , 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.
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]'.
FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
PARTITION_TYPE: Partitioning scheme to use. Supported values:
- RANGE: Use range partitioning.
- INTERVAL: Use interval partitioning.
- LIST: Use list partitioning.
- HASH: Use hash partitioning.
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.
PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, or hash partitioning for example formats.
IS_AUTOMATIC_PARTITION: 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.
TTL: For a table, sets the TTL of the table specified in .
CHUNK_SIZE: Indicates the number of records per chunk to be used for this table.
IS_RESULT_TABLE: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:
- TRUE
- FALSE
The default value is FALSE.
STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 295 of file CreateTable.cs.

Member Data Documentation

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

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

Name of a collection which is to contain the newly created table.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.

Definition at line 323 of file CreateTable.cs.

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

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

Definition at line 317 of file CreateTable.cs.

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

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

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

Use hash partitioning.

Definition at line 454 of file CreateTable.cs.

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

Use interval partitioning.

Definition at line 444 of file CreateTable.cs.

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.

Currently only supported for list partitions. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 493 of file CreateTable.cs.

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

Indicates whether the new table to be created will be a collection.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 340 of file CreateTable.cs.

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

For a table, 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 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 386 of file CreateTable.cs.

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

For a table, indicates whether the table is an in-memory table.

A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 521 of file CreateTable.cs.

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

Use list partitioning.

Definition at line 449 of file CreateTable.cs.

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.

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

TRUE
FALSE

The default value is FALSE.

Definition at line 315 of file CreateTable.cs.

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, or hash partitioning for example formats.

Definition at line 473 of file CreateTable.cs.

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

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

Partitioning scheme to use.

Supported values:

Definition at line 434 of file CreateTable.cs.

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

Use range partitioning.

Definition at line 439 of file CreateTable.cs.

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

The tier strategy for the table and its columns.

See tier strategy usage for format and tier strategy examples for examples.

Definition at line 529 of file CreateTable.cs.

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

Definition at line 316 of file CreateTable.cs.

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

For a table, sets the TTL of the table specified in table_name.

Definition at line 498 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