Kinetica C# API
Version 7.2.3.0
|
A set of parameters for Kinetica.createType. More...
Classes | |
struct | Options |
A set of string constants for the parameter options. More... | |
struct | Properties |
A set of string constants for the parameter properties. More... | |
Public Member Functions | |
CreateTypeRequest () | |
Constructs a CreateTypeRequest object with default parameters. More... | |
CreateTypeRequest (string type_definition, string label, IDictionary< string, IList< string >> properties=null, IDictionary< string, string > options=null) | |
Constructs a CreateTypeRequest object with the specified parameters. More... | |
CreateTypeRequest () | |
Constructs a CreateTypeRequest object with default parameters. More... | |
CreateTypeRequest (string type_definition, string label, IDictionary< string, IList< string >> properties=null, IDictionary< string, string > options=null) | |
Constructs a CreateTypeRequest object with the specified parameters. More... | |
![]() | |
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... | |
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 | type_definition [get, set] |
a JSON string describing the columns of the type to be registered, as described above. More... | |
string | label [get, set] |
A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. More... | |
IDictionary< string, IList< string > > | properties = new Dictionary<string, IList<string>>() [get, set] |
[DEPRECATED–please use these property values in the type_definition directly, as described at the top, instead] Each key-value pair specifies the properties to use for a given column where the key is the column name. More... | |
IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
Optional parameters. More... | |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
![]() | |
Schema | Schema [get] |
Additional Inherited Members | |
![]() | |
static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.createType.
Creates a new type describing the columns of a table. The type definition is specified as a list of columns, each specified as a list of the column name, data type, and any column attributes.
Example of a type definition with some parameters:
Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the possible values for properties), and any data handling, data key, or data replacement properties.
Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are PRIMARY_KEY and NULLABLE.
A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key column value (or set of values for the key columns, if using a composite primary key). When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
Definition at line 59 of file CreateType.cs.
|
inline |
Constructs a CreateTypeRequest object with default parameters.
Definition at line 644 of file CreateType.cs.
|
inline |
Constructs a CreateTypeRequest object with the specified parameters.
type_definition | a JSON string describing the columns of the type to be registered, as described above. |
label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
properties | [DEPRECATED–please use these property values in the type_definition directly, as described at the top, instead] Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Valid values are:
|
options | Optional parameters.
|
Definition at line 960 of file CreateType.cs.
|
inline |
Constructs a CreateTypeRequest object with default parameters.
Definition at line 644 of file CreateType.cs.
|
inline |
Constructs a CreateTypeRequest object with the specified parameters.
type_definition | a JSON string describing the columns of the type to be registered, as described above. |
label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
properties | [DEPRECATED–please use these property values in the type_definition directly, as described at the top, instead] Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Valid values are:
|
options | Optional parameters.
|
Definition at line 960 of file CreateType.cs.
|
getset |
A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
Definition at line 333 of file CreateType.cs.
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 640 of file CreateType.cs.
|
getset |
[DEPRECATED–please use these property values in the type_definition directly, as described at the top, instead] Each key-value pair specifies the properties to use for a given column where the key is the column name.
Valid values are:
The default value is an empty Dictionary.
Definition at line 625 of file CreateType.cs.
|
getset |
a JSON string describing the columns of the type to be registered, as described above.
Definition at line 328 of file CreateType.cs.