Kinetica C# API  Version 6.2.0.1
Public Attributes | List of all members
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 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"
 For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. More...
 
const string IS_REPLICATED = "is_replicated"
 For a table, indicates 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 TTL = "ttl"
 For a table, sets the TTL of the table specified in table_name. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the chunk size 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...
 

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: 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: The default value is FALSE.
  • DISALLOW_HOMOGENEOUS_TABLES: For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Supported values: The default value is FALSE.
  • IS_REPLICATED: For a table, indicates the distribution scheme for the table's data. If true, 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. 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)'
  • TTL: For a table, sets the TTL of the table specified in .
  • CHUNK_SIZE: Indicates the chunk size 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: The default value is FALSE.

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

Definition at line 187 of file CreateTable.cs.

Member Data Documentation

◆ CHUNK_SIZE

const string kinetica.CreateTableRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the chunk size to be used for this table.

Definition at line 301 of file CreateTable.cs.

◆ COLLECTION_NAME

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

◆ DISALLOW_HOMOGENEOUS_TABLES

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

For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type.

Supported values:

The default value is FALSE.

Definition at line 250 of file CreateTable.cs.

◆ FALSE

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

Definition at line 209 of file CreateTable.cs.

◆ FOREIGN_KEYS

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

◆ FOREIGN_SHARD_KEY

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

◆ IS_COLLECTION

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

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

Supported values:

The default value is FALSE.

Definition at line 232 of file CreateTable.cs.

◆ IS_REPLICATED

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

For a table, indicates the distribution scheme for the table's data.

If true, 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. Supported values:

The default value is FALSE.

Definition at line 279 of file CreateTable.cs.

◆ IS_RESULT_TABLE

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:

The default value is FALSE.

Definition at line 320 of file CreateTable.cs.

◆ NO_ERROR_IF_EXISTS

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

◆ TRUE

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

Definition at line 208 of file CreateTable.cs.

◆ TTL

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

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

Definition at line 297 of file CreateTable.cs.

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