A set of parameters for /create/table. 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 /create/table.

Creates a new table or collection. If a new table is being created, the type of the table is given by <member name="type_id">, which must the be the ID of a currently registered type (i.e. one created via /create/type). 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 <member name="table_name"> and set the is_collection option to true; <member name="type_id"> will be ignored.

Definition at line 26 of file CreateTable.cs.

Constructor & Destructor Documentation

kinetica.CreateTableRequest.CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameters.

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

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

Definition at line 247 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 170 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 175 of file CreateTable.cs.

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

Kinetica/Protocol/CreateTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation