kinetica.CreateTableRequest Class Reference

A set of parameters for Kinetica.createTable(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.CreateTableRequest:

Collaboration diagram for kinetica.CreateTableRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	CreateTableRequest ()
	Constructs a CreateTableRequest object with default parameters. More...
	CreateTableRequest (string table_name, string type_id, IDictionary< string, string > options=null)
	Constructs a CreateTableRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name [get, set]
	Name of the table to be created. More...
string	type_id [get, set]
	ID of a currently registered type. More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createTable(string,string,IDictionary{string, string}).

Creates a new table or collection. If a new table is being created, the type of the table is given by type_id, which must be the ID of a currently registered type (i.e. one created via Kinetica.createType(string,string,IDictionary{string, IList{string}},IDictionary{string, string})). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.
To create a new collection, specify the name of the collection in table_name and set the is_collection option to true; type_id will be ignored.
A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.

Definition at line 43 of file CreateTable.cs.

Constructor & Destructor Documentation

kinetica.CreateTableRequest.CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameters.

Definition at line 797 of file CreateTable.cs.

kinetica.CreateTableRequest.CreateTableRequest ( string  table_name, string  type_id, IDictionary< string, string >  options = null  )

inline

Constructs a CreateTableRequest object with the specified parameters.

Parameters

table_name	Name of the table to be created. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.
type_id	ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
options	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: TRUE FALSE 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: TRUE FALSE The default value is FALSE. DISALLOW_HOMOGENEOUS_TABLES: No longer supported; value will be ignored. Supported values: TRUE FALSE The default value is FALSE. IS_REPLICATED: For a table, 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 , 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. 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, or hash 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: For a table, 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: 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: TRUE FALSE The default value is FALSE. STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples. The default value is an empty Dictionary.

Definition at line 1058 of file CreateTable.cs.

Property Documentation

IDictionary<string, string> kinetica.CreateTableRequest.options

getset

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:
  • TRUE
  • FALSE
  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:
  • TRUE
  • FALSE
  The default value is FALSE.
• DISALLOW_HOMOGENEOUS_TABLES: No longer supported; value will be ignored. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• IS_REPLICATED: For a table, 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 , 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.
• 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, or hash 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: For a table, 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: 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples.

The default value is an empty Dictionary.

Definition at line 792 of file CreateTable.cs.

string kinetica.CreateTableRequest.table_name

getset

Name of the table to be created.

Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.

Definition at line 538 of file CreateTable.cs.

string kinetica.CreateTableRequest.type_id

getset

ID of a currently registered type.

All objects added to the newly created table will be of this type. Ignored if is_collection is true.

Definition at line 543 of file CreateTable.cs.

---

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

• Kinetica/Protocol/CreateTable.cs