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

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 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 table_name. More...
 
const string COLLECTION_NAME = "collection_name"
 [DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema which is to contain the newly created table. More...
 
const string IS_COLLECTION = "is_collection"
 [DEPRECATED–please use Kinetica.createSchema(string,IDictionary{string, string}) to create a schema instead] Indicates whether to create a schema instead of a table. More...
 
const string DISALLOW_HOMOGENEOUS_TABLES = "disallow_homogeneous_tables"
 No longer supported; value will be ignored. More...
 
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

Optional parameters.

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

Definition at line 321 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 567 of file CreateTable.cs.

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

[DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) 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 372 of file CreateTable.cs.

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

const string kinetica.CreateTableRequest.Options.DISALLOW_HOMOGENEOUS_TABLES = "disallow_homogeneous_tables"

No longer supported; value will be ignored.

Supported values:

The default value is FALSE.

Definition at line 407 of file CreateTable.cs.

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

Definition at line 343 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 445 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 450 of file CreateTable.cs.

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

Use hash partitioning.

Definition at line 512 of file CreateTable.cs.

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

Use interval partitioning.

Definition at line 502 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:

The default value is FALSE.

Definition at line 558 of file CreateTable.cs.

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

[DEPRECATED–please use Kinetica.createSchema(string,IDictionary{string, string}) 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 391 of file CreateTable.cs.

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

The default value is FALSE.

Definition at line 437 of file CreateTable.cs.

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

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

Use list partitioning.

Definition at line 507 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:

The default value is FALSE.

Definition at line 341 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, hash partitioning, or series partitioning for example formats.

Definition at line 538 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 523 of file CreateTable.cs.

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

Partitioning scheme to use.

Supported values:

Definition at line 492 of file CreateTable.cs.

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

Use range partitioning.

Definition at line 497 of file CreateTable.cs.

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

Use series partitioning.

Definition at line 517 of file CreateTable.cs.

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

The tier strategy for the table and its columns.

Definition at line 596 of file CreateTable.cs.

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

Definition at line 342 of file CreateTable.cs.

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

Sets the TTL of the table specified in table_name.

Definition at line 563 of file CreateTable.cs.


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