A set of parameters for Kinetica.createType(string,string,IDictionary<string, IList<string>>,IDictionary<string, string>). More...

Inheritance diagram for kinetica.CreateTypeRequest:

Collaboration diagram for kinetica.CreateTypeRequest:

Classes
struct	Properties
	Each key-value pair specifies the properties to use for a given column where the key is the column name. 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...

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	type_definition `[get, set]`
	a JSON string describing the columns of the type to be registered. 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 `[get, set]`
	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, IList<string>>() `[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.createType(string,string,IDictionary<string, IList<string>>,IDictionary<string, string>).

Creates a new type describing the layout or schema of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. 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 data and store_only.
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. 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.
Example of a type definition with some of the parameters::
{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
Properties::
{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Definition at line 58 of file CreateType.cs.

Constructor & Destructor Documentation

◆ CreateTypeRequest() [1/2]

kinetica.CreateTypeRequest.CreateTypeRequest ( )

inline

Constructs a CreateTypeRequest object with default parameters.

Definition at line 730 of file CreateType.cs.

◆ CreateTypeRequest() [2/2]

kinetica.CreateTypeRequest.CreateTypeRequest	(	string	type_definition,
		string	label,
		IDictionary< string, IList< string >>	properties = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTypeRequest object with the specified parameters.

Parameters

type_definition	a JSON string describing the columns of the type to be registered.
label	A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
properties	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: DATA: Default property for all numeric and string type columns; makes the column available for GPU queries. TEXT_SEARCH: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only. STORE_ONLY: Persist the column value but do not make it available to queries (e.g. /filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage. DISK_OPTIMIZED: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like /filter, /filter/bylist, and /filter/byvalue work as usual but /aggregate/unique, /aggregate/groupby and /get/records/bycolumn are not allowed on columns with this property. TIMESTAMP: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900. DECIMAL: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property. DATE: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property. TIME: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property. DATETIME: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property. CHAR1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character. CHAR2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters. CHAR4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters. CHAR8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters. CHAR16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters. CHAR32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters. CHAR64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters. CHAR128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters. CHAR256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters. INT8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive) INT16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive) IPV4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255. WKT: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format. PRIMARY_KEY: This property indicates that this column will be part of (or the entire) primary key. SHARD_KEY: This property indicates that this column will be part of (or the entire) shard key. NULLABLE: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in . For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record. DICT: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory. INIT_WITH_NOW: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 974 of file CreateType.cs.

Property Documentation

◆ label

string kinetica.CreateTypeRequest.label

getset

A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.

Definition at line 487 of file CreateType.cs.

◆ options

IDictionary<string, string> kinetica.CreateTypeRequest.options = new Dictionary<string, IList<string>>()

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 725 of file CreateType.cs.

◆ properties

IDictionary<string, IList<string> > kinetica.CreateTypeRequest.properties

getset

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:

DATA: Default property for all numeric and string type columns; makes the column available for GPU queries.
TEXT_SEARCH: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only.
STORE_ONLY: Persist the column value but do not make it available to queries (e.g. /filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
DISK_OPTIMIZED: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like /filter, /filter/bylist, and /filter/byvalue work as usual but /aggregate/unique, /aggregate/groupby and /get/records/bycolumn are not allowed on columns with this property.
TIMESTAMP: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
DECIMAL: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
DATE: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
TIME: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
DATETIME: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
CHAR1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
CHAR2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
CHAR4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
CHAR8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
CHAR16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
CHAR32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
CHAR64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
CHAR128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
CHAR256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
INT8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
INT16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
IPV4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
WKT: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
PRIMARY_KEY: This property indicates that this column will be part of (or the entire) primary key.
SHARD_KEY: This property indicates that this column will be part of (or the entire) shard key.
NULLABLE: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in . For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null'].
The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
DICT: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory.
INIT_WITH_NOW: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()

Definition at line 721 of file CreateType.cs.

◆ type_definition

string kinetica.CreateTypeRequest.type_definition

getset

a JSON string describing the columns of the type to be registered.

Definition at line 482 of file CreateType.cs.

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

Kinetica/Protocol/CreateType.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateTypeRequest() [1/2]

◆ CreateTypeRequest() [2/2]

Property Documentation

◆ label

◆ options

◆ properties

◆ type_definition