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 whether the table is to be replicated to all the database ranks. More...

const string	FOREIGN_KEYS = "foreign_keys"
	Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. 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"
	Sets the TTL of the table or collection specified in <member name="table_name">. More...

const string	IS_RESULT_TABLE = "is_result_table"
	For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with /execute/proc. 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. Values: true, false.
collection_name Name of a collection which is to contain the newly created table. If empty, then the newly created table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
is_collection Indicates whether the new table to be created will be a collection. Values: true, false.
disallow_homogeneous_tables For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Values: true, false.
is_replicated For a table, indicates whether the table is to be replicated to all the database ranks. This may be necessary when the table is to be joined with other tables in a query. Values: true, false.
foreign_keys Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.
foreign_shard_key Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'
ttl Sets the TTL of the table or collection specified in . The value must be the desired TTL in minutes.
is_result_table For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with /execute/proc. A result table cannot contain store_only, text_search, or string columns (char columns are acceptable), records cannot be inserted into it directly, and it will not be retained if the server is restarted. Values: true, false.

A set of string constants for the parameter <member name="options">.

Definition at line 101 of file CreateTable.cs.

Member Data Documentation

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

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

If empty, then the newly created table will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.

Definition at line 118 of file CreateTable.cs.

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.

Values: true, false.

Definition at line 129 of file CreateTable.cs.

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

Definition at line 111 of file CreateTable.cs.

const string kinetica.CreateTableRequest.Options.FOREIGN_KEYS = "foreign_keys"

Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'.

Definition at line 141 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 146 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.

Values: true, false.

Definition at line 123 of file CreateTable.cs.

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

For a table, indicates whether the table is to be replicated to all the database ranks.

This may be necessary when the table is to be joined with other tables in a query. Values: true, false.

Definition at line 136 of file CreateTable.cs.

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

For a table, indicates whether the table is a non-persistent, memory-only table that will store the output of a proc executed with /execute/proc.

A result table cannot contain store_only, text_search, or string columns (char columns are acceptable), records cannot be inserted into it directly, and it will not be retained if the server is restarted. Values: true, false.

Definition at line 161 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. Values: true, false.

Definition at line 109 of file CreateTable.cs.

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

Definition at line 110 of file CreateTable.cs.

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

Sets the TTL of the table or collection specified in <member name="table_name">.

The value must be the desired TTL in minutes.

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