Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.InsertRecordsFromFilesRequest.CreateTableOptions Struct Reference

Options from /create/table, allowing the structure of the table to be defined independently of the data source, 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 from /create/table, allowing the structure of the table to be defined independently of the data source, when creating the target table

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 name but a different type exists, it is still an error. Supported values:

The default value is FALSE. IS_REPLICATED: Affects the distribution scheme for the table's data. If true and the given table 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:

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:

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:

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:

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 285 of file InsertRecordsFromFiles.cs.

Member Data Documentation

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

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

Definition at line 480 of file InsertRecordsFromFiles.cs.

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

Definition at line 313 of file InsertRecordsFromFiles.cs.

const string kinetica.InsertRecordsFromFilesRequest.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 355 of file InsertRecordsFromFiles.cs.

const string kinetica.InsertRecordsFromFilesRequest.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 360 of file InsertRecordsFromFiles.cs.

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

Use hash partitioning.

Definition at line 422 of file InsertRecordsFromFiles.cs.

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

Use interval partitioning.

Definition at line 412 of file InsertRecordsFromFiles.cs.

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

The default value is FALSE.

Definition at line 471 of file InsertRecordsFromFiles.cs.

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

Affects the distribution scheme for the table's data.

If true and the given table 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:

The default value is FALSE.

Definition at line 347 of file InsertRecordsFromFiles.cs.

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

The default value is FALSE.

Definition at line 506 of file InsertRecordsFromFiles.cs.

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

Use list partitioning.

Definition at line 417 of file InsertRecordsFromFiles.cs.

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

The default value is FALSE.

Definition at line 311 of file InsertRecordsFromFiles.cs.

const string kinetica.InsertRecordsFromFilesRequest.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 450 of file InsertRecordsFromFiles.cs.

const string kinetica.InsertRecordsFromFilesRequest.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 434 of file InsertRecordsFromFiles.cs.

const string kinetica.InsertRecordsFromFilesRequest.CreateTableOptions.PARTITION_TYPE = "partition_type"
const string kinetica.InsertRecordsFromFilesRequest.CreateTableOptions.RANGE = "RANGE"

Use range partitioning.

Definition at line 407 of file InsertRecordsFromFiles.cs.

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

Use series partitioning.

Definition at line 427 of file InsertRecordsFromFiles.cs.

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

The tier strategy for the table and its columns.

Definition at line 511 of file InsertRecordsFromFiles.cs.

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

Definition at line 312 of file InsertRecordsFromFiles.cs.

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

Sets the TTL of the table specified in table_name.

Definition at line 476 of file InsertRecordsFromFiles.cs.

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

ID of a currently registered type.

Definition at line 291 of file InsertRecordsFromFiles.cs.


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