Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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, in [schema_name. 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. 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})).
A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Definition at line 34 of file CreateTable.cs.

Constructor & Destructor Documentation

kinetica.CreateTableRequest.CreateTableRequest ( )
inline

Constructs a CreateTableRequest object with default parameters.

Definition at line 901 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_nameName of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option.
type_idID of a currently registered type. All objects added to the newly created table will be of this type.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 1200 of file CreateTable.cs.

Property Documentation

IDictionary<string, string> kinetica.CreateTableRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 896 of file CreateTable.cs.

string kinetica.CreateTableRequest.table_name
getset

Name of the table to be created, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option.

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

Definition at line 612 of file CreateTable.cs.


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