Options used when creating the target table. More...

Public Attributes
const string	TYPE_ID = "type_id"
	ID of a currently registered type. More...

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

Detailed Description

Options used when creating the target table.

Includes type to use. The other options match those in /create/table

TYPE_ID: ID of a currently registered type. The default value is ''.
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.
IS_REPLICATED: 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.
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.
- SERIES: Use series 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, hash partitioning, or series 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: 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: Indicates whether the table is a memory-only table. A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, 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.

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

Definition at line 248 of file InsertRecordsFromPayload.cs.

Member Data Documentation

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.CHUNK_SIZE = "chunk_size"

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

Definition at line 435 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.FALSE = "false"

Definition at line 275 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 313 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 318 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.HASH = "HASH"

Use hash partitioning.

Definition at line 380 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.INTERVAL = "INTERVAL"

Use interval partitioning.

Definition at line 370 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 426 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.IS_REPLICATED = "is_replicated"

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 305 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.IS_RESULT_TABLE = "is_result_table"

Indicates whether the table is a memory-only table.

A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, and it will not be retained if the server is restarted. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 459 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.LIST = "LIST"

Use list partitioning.

Definition at line 375 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 273 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 406 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.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 391 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.PARTITION_TYPE = "partition_type"

Partitioning scheme to use.

Supported values:

Definition at line 360 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.RANGE = "RANGE"

Use range partitioning.

Definition at line 365 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.SERIES = "SERIES"

Use series partitioning.

Definition at line 385 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.STRATEGY_DEFINITION = "strategy_definition"

The tier strategy for the table and its columns.

Definition at line 464 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.TRUE = "true"

Definition at line 274 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.TTL = "ttl"

Sets the TTL of the table specified in table_name.

Definition at line 431 of file InsertRecordsFromPayload.cs.

const string kinetica.InsertRecordsFromPayloadRequest.CreateTableOptions.TYPE_ID = "type_id"

ID of a currently registered type.

The default value is ''.

Definition at line 254 of file InsertRecordsFromPayload.cs.

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

Kinetica/Protocol/InsertRecordsFromPayload.cs

Public Attributes

Detailed Description

Member Data Documentation