Classes
class	Column

Public Member Functions
	KineticaType (IList< Column > columns)
	Create a KineticaType object with the given column information. More...

	KineticaType (string label, IList< Column > columns)
	Create a KineticaType object with the given column and label information. More...

	KineticaType (string label, IList< Column > columns, IDictionary< string, IList< string >> properties)
	Create a KineticaType object with the given column, label, and property information. More...

	KineticaType (string typeSchema)
	Create a KineticaType object using the string-formatted schema for the type. More...

	KineticaType (string label, string typeSchema, IDictionary< string, IList< string >> properties, string? typeId=null)
	Create a KineticaType object using the string-formatted schema and properties for its columns. More...

string	getLabel ()

IList< Column >	getColumns ()

Column	getColumn (int index)

Column	getColumn (string name)

int	getColumnCount ()

int	getColumnIndex (string name)

bool	hasColumn (string name)

Schema	getSchema ()

Type?	getSourceType ()

string	getSchemaString ()

string	getTypeID ()

void	saveSourceType (Type sourceType)
	Saves the given type as this KineticaType's source type. More...

string	create (Kinetica kinetica)
	Given a handle to the server, creates a type in the database based on this data type. More...

Static Public Member Functions
static KineticaType	fromTable (Kinetica kinetica, string tableName)
	Create a KineticaType object based on an existing table in the database. More...

static KineticaType	fromTypeID (Kinetica kinetica, string typeId)
	Create a KineticaType object based on an existing type in the database. More...

static KineticaType	fromDynamicSchema (string dynamicTableSchemaString, Object[] columnHeaders, Object[] columnTypes)
	Create a KineticaType object based on information provided in a dynamic schema. More...

static KineticaType	fromClass (Type recordClass, IDictionary< string, IList< string >> properties=null)
	Create a KineticaType object from properties of a record class and Kinetica column properties. More...

static KineticaType	fromClass (Type recordClass, string label, IDictionary< string, IList< string >>? properties=null)
	Create a KineticaType object from properties of a record class and Kinetica column properties. More...

static KineticaType	fromObject (Object recordObj, IDictionary< string, IList< string >> properties=null)
	Create a KineticaType object from properties of a record object and Kinetica column properties. More...

static KineticaType	fromObject (Object recordObj, string label="", IDictionary< string, IList< string >> properties=null)
	Create a KineticaType object from properties of a record object and Kinetica column properties. More...

Detailed Description

Definition at line 10 of file KineticaType.cs.

Constructor & Destructor Documentation

◆ KineticaType() [1/5]

KineticaType.KineticaType ( IList< Column > columns )

inline

Create a KineticaType object with the given column information.

Parameters

columns A list of Columns with information on all the columns for the type.

Definition at line 653 of file KineticaType.cs.

◆ KineticaType() [2/5]

KineticaType.KineticaType	(	string	label,
		IList< Column >	columns
	)

inline

Create a KineticaType object with the given column and label information.

Parameters

label	The label for the type.
columns	A list of Columns with information on all the columns for the type.

Definition at line 665 of file KineticaType.cs.

◆ KineticaType() [3/5]

KineticaType.KineticaType	(	string	label,
		IList< Column >	columns,
		IDictionary< string, IList< string >>	properties
	)

inline

Create a KineticaType object with the given column, label, and property information.

Parameters

label	The label for the type.
columns	A list of Columns with information on all the columns for the type.
properties	A per-column property information

Definition at line 676 of file KineticaType.cs.

◆ KineticaType() [4/5]

KineticaType.KineticaType ( string typeSchema )

inline

Create a KineticaType object using the string-formatted schema for the type.

Parameters

typeSchema

Definition at line 685 of file KineticaType.cs.

◆ KineticaType() [5/5]

KineticaType.KineticaType	(	string	label,
		string	typeSchema,
		IDictionary< string, IList< string >>	properties,
		string?	typeId = `null`
	)

inline

Create a KineticaType object using the string-formatted schema and properties for its columns.

Parameters

label	The label for the type.
typeSchema	The string-formatted schema for the type.
properties	A per-column based set of properties.
typeId	An optional ID for this type with which to identify it in the database.

Definition at line 699 of file KineticaType.cs.

Member Function Documentation

◆ create()

string KineticaType.create ( Kinetica kinetica )

inline

Given a handle to the server, creates a type in the database based on this data type.

Parameters

kinetica The handle to the database server.

Returns: The ID with which the database identifies this type.

Definition at line 737 of file KineticaType.cs.

◆ fromClass() [1/2]

static KineticaType KineticaType.fromClass	(	Type	recordClass,
		IDictionary< string, IList< string >>	properties = `null`
	)

inlinestatic

Create a KineticaType object from properties of a record class and Kinetica column properties.

It ignores any properties inherited from base classes, and also ignores any member fields of the class.

For integer, long, float, and double column types, the user can use the nullable type (e.g. int?) to declare the column to be nullable. The properties does not need to contain the ColumnProperty.NULLABLE property. However, for string type columns, instead of using nullable type, use the regular string type; additionally, add the ColumnProperty.NULLABLE in properties .

Parameters

recordClass	A class type.
properties	Properties for the columns.

Returns

Definition at line 499 of file KineticaType.cs.

◆ fromClass() [2/2]

static KineticaType KineticaType.fromClass	(	Type	recordClass,
		string	label,
		IDictionary< string, IList< string >>?	properties = `null`
	)

inlinestatic

Create a KineticaType object from properties of a record class and Kinetica column properties.

It ignores any properties inherited from base classes, and also ignores any member fields of the class.

Parameters

recordClass	A class type.
label	Any label for the type.
properties	Properties for the columns.

Returns

Definition at line 514 of file KineticaType.cs.

◆ fromDynamicSchema()

static KineticaType KineticaType.fromDynamicSchema	(	string	dynamicTableSchemaString,
		Object []	columnHeaders,
		Object []	columnTypes
	)

inlinestatic

Create a KineticaType object based on information provided in a dynamic schema.

Parameters

dynamicTableSchemaString	The dynamic schema string.
columnHeaders	List of column names.
columnTypes	List of column types.

Returns

Definition at line 294 of file KineticaType.cs.

◆ fromObject() [1/2]

static KineticaType KineticaType.fromObject	(	Object	recordObj,
		IDictionary< string, IList< string >>	properties = `null`
	)

inlinestatic

Create a KineticaType object from properties of a record object and Kinetica column properties.

It ignores any properties inherited from base classes, and also ignores any member fields of the class.

Parameters

recordObj	A record object.
properties	Properties for the columns.

Returns

Definition at line 624 of file KineticaType.cs.

◆ fromObject() [2/2]

static KineticaType KineticaType.fromObject	(	Object	recordObj,
		string	label = `""`,
		IDictionary< string, IList< string >>	properties = `null`
	)

inlinestatic

Create a KineticaType object from properties of a record object and Kinetica column properties.

It ignores any properties inherited from base classes, and also ignores any member fields of the class.

Parameters

recordObj	A record object.
label	Any label for the type.
properties	Properties for the columns.

Returns

Definition at line 639 of file KineticaType.cs.

◆ fromTable()

static KineticaType KineticaType.fromTable	(	Kinetica	kinetica,
		string	tableName
	)

inlinestatic

Create a KineticaType object based on an existing table in the database.

Parameters

kinetica
tableName

Returns

Definition at line 243 of file KineticaType.cs.

◆ fromTypeID()

static KineticaType KineticaType.fromTypeID	(	Kinetica	kinetica,
		string	typeId
	)

inlinestatic

Create a KineticaType object based on an existing type in the database.

Parameters

kinetica
typeId

Returns

Definition at line 274 of file KineticaType.cs.

◆ getColumn() [1/2]

Column KineticaType.getColumn ( int index )

inline

Definition at line 711 of file KineticaType.cs.

◆ getColumn() [2/2]

Column KineticaType.getColumn ( string name )

inline

Definition at line 712 of file KineticaType.cs.

◆ getColumnCount()

int KineticaType.getColumnCount ( )

inline

Definition at line 713 of file KineticaType.cs.

◆ getColumnIndex()

int KineticaType.getColumnIndex ( string name )

inline

Definition at line 714 of file KineticaType.cs.

◆ getColumns()

IList<Column> KineticaType.getColumns ( )

inline

Definition at line 710 of file KineticaType.cs.

◆ getLabel()

string KineticaType.getLabel ( )

inline

Definition at line 709 of file KineticaType.cs.

◆ getSchema()

Schema KineticaType.getSchema ( )

inline

Definition at line 716 of file KineticaType.cs.

◆ getSchemaString()

string KineticaType.getSchemaString ( )

inline

Definition at line 718 of file KineticaType.cs.

◆ getSourceType()

Type? KineticaType.getSourceType ( )

inline

Definition at line 717 of file KineticaType.cs.

◆ getTypeID()

string KineticaType.getTypeID ( )

inline

Definition at line 719 of file KineticaType.cs.

◆ hasColumn()

bool KineticaType.hasColumn ( string name )

inline

Definition at line 715 of file KineticaType.cs.

◆ saveSourceType()

void KineticaType.saveSourceType ( Type sourceType )

inline

Saves the given type as this KineticaType's source type.

Parameters

sourceType The type that works as the source.

Definition at line 725 of file KineticaType.cs.

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

Kinetica/KineticaType.cs

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KineticaType() [1/5]

◆ KineticaType() [2/5]

◆ KineticaType() [3/5]

◆ KineticaType() [4/5]

◆ KineticaType() [5/5]

Member Function Documentation

◆ create()

◆ fromClass() [1/2]

◆ fromClass() [2/2]

◆ fromDynamicSchema()

◆ fromObject() [1/2]

◆ fromObject() [2/2]

◆ fromTable()

◆ fromTypeID()

◆ getColumn() [1/2]

◆ getColumn() [2/2]

◆ getColumnCount()

◆ getColumnIndex()

◆ getColumns()

◆ getLabel()

◆ getSchema()

◆ getSchemaString()

◆ getSourceType()

◆ getTypeID()

◆ hasColumn()

◆ saveSourceType()