Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type in the database. More...

Classes
class	Column
	Describes a single column of a KineticaType: its name, data type, and properties. More...

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

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

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

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

	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.

string	getLabel ()
	Gets the type's label.

IList\< Column >	getColumns ()
	Gets the list of columns that make up the type.

Column	getColumn (int index)
	Gets the column at the given zero-based index.

Column	getColumn (string name)
	Gets the column with the given name.

int	getColumnCount ()
	Gets the number of columns in the type.

int	getColumnIndex (string name)
	Gets the zero-based index of the column with the given name.

bool	hasColumn (string name)
	Determines whether the type contains a column with the given name.

Schema	getSchema ()
	Gets the Avro schema describing the type.

Type?	getSourceType ()
	Gets the .NET source type this Kinetica type was built from, or null if none.

string	getSchemaString ()
	Gets the Avro schema as a JSON string.

string	getTypeID ()
	Gets the server-assigned type ID, or empty if the type has not been created in the database.

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

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

	KineticaType (IList\< Column > columns)
	Create a KineticaType object with the given column information.

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

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

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

	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.

string	getLabel ()
	Gets the type's label.

IList\< Column >	getColumns ()
	Gets the list of columns that make up the type.

Column	getColumn (int index)
	Gets the column at the given zero-based index.

Column	getColumn (string name)
	Gets the column with the given name.

int	getColumnCount ()
	Gets the number of columns in the type.

int	getColumnIndex (string name)
	Gets the zero-based index of the column with the given name.

bool	hasColumn (string name)
	Determines whether the type contains a column with the given name.

Schema	getSchema ()
	Gets the Avro schema describing the type.

Type?	getSourceType ()
	Gets the .NET source type this Kinetica type was built from, or null if none.

string	getSchemaString ()
	Gets the Avro schema as a JSON string.

string	getTypeID ()
	Gets the server-assigned type ID, or empty if the type has not been created in the database.

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

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

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

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

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

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.

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.

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.

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.

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

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

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

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.

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.

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.

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.

Detailed Description

Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type in the database.

Definition at line 9 of file KineticaType.cs.

Constructor & Destructor Documentation

◆ KineticaType() \[1/10]

kinetica.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 696 of file KineticaType.cs.

◆ KineticaType() \[2/10]

kinetica.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 708 of file KineticaType.cs.

◆ KineticaType() \[3/10]

kinetica.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 719 of file KineticaType.cs.

◆ KineticaType() \[4/10]

kinetica.KineticaType.KineticaType

(

string

typeSchema

)

inline

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

Parameters

typeSchema

Definition at line 728 of file KineticaType.cs.

◆ KineticaType() \[5/10]

kinetica.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 742 of file KineticaType.cs.

◆ KineticaType() \[6/10]

kinetica.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 696 of file KineticaType.cs.

◆ KineticaType() \[7/10]

kinetica.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 708 of file KineticaType.cs.

◆ KineticaType() \[8/10]

kinetica.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 719 of file KineticaType.cs.

◆ KineticaType() \[9/10]

kinetica.KineticaType.KineticaType

(

string

typeSchema

)

inline

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

Parameters

typeSchema

Definition at line 728 of file KineticaType.cs.

◆ KineticaType() \[10/10]

kinetica.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 742 of file KineticaType.cs.

Member Function Documentation

◆ create() \[1/2]

string kinetica.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 795 of file KineticaType.cs.

◆ create() \[2/2]

string kinetica.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 795 of file KineticaType.cs.

◆ fromClass() \[1/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record class properties. It is not compatible with trimming or Native AOT compilation.

Definition at line 527 of file KineticaType.cs.

◆ fromClass() \[2/4]

static KineticaType kinetica.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.

Parameters

recordClass	A class type.
properties	Properties for the columns.

Returns

This method uses reflection to inspect the record class properties. It is not compatible with trimming or Native AOT compilation.

Definition at line 527 of file KineticaType.cs.

◆ fromClass() \[3/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record class properties. It is not compatible with trimming or Native AOT compilation.

Definition at line 547 of file KineticaType.cs.

◆ fromClass() \[4/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record class properties. It is not compatible with trimming or Native AOT compilation.

Definition at line 547 of file KineticaType.cs.

◆ fromDynamicSchema() \[1/2]

static KineticaType kinetica.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

This method parses dynamic JSON schemas at runtime and creates types dynamically. It is not compatible with trimming or Native AOT compilation.

Definition at line 309 of file KineticaType.cs.

◆ fromDynamicSchema() \[2/2]

static KineticaType kinetica.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

This method parses dynamic JSON schemas at runtime and creates types dynamically. It is not compatible with trimming or Native AOT compilation.

Definition at line 309 of file KineticaType.cs.

◆ fromObject() \[1/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record object's type. It is not compatible with trimming or Native AOT compilation.

Definition at line 662 of file KineticaType.cs.

◆ fromObject() \[2/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record object's type. It is not compatible with trimming or Native AOT compilation.

Definition at line 662 of file KineticaType.cs.

◆ fromObject() \[3/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record object's type. It is not compatible with trimming or Native AOT compilation.

Definition at line 682 of file KineticaType.cs.

◆ fromObject() \[4/4]

static KineticaType kinetica.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

This method uses reflection to inspect the record object's type. It is not compatible with trimming or Native AOT compilation.

Definition at line 682 of file KineticaType.cs.

◆ fromTable() \[1/2]

static KineticaType kinetica.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 253 of file KineticaType.cs.

◆ fromTable() \[2/2]

static KineticaType kinetica.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 253 of file KineticaType.cs.

◆ fromTypeID() \[1/2]

static KineticaType kinetica.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 284 of file KineticaType.cs.

◆ fromTypeID() \[2/2]

static KineticaType kinetica.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 284 of file KineticaType.cs.

◆ getColumn() \[1/4]

Column kinetica.KineticaType.getColumn

(

int

index

)

inline

Gets the column at the given zero-based index.

Parameters

index

The zero-based column index.

Definition at line 758 of file KineticaType.cs.

◆ getColumn() \[2/4]

Column kinetica.KineticaType.getColumn

(

int

index

)

inline

Gets the column at the given zero-based index.

Parameters

index

The zero-based column index.

Definition at line 758 of file KineticaType.cs.

◆ getColumn() \[3/4]

Column kinetica.KineticaType.getColumn

(

string

name

)

inline

Gets the column with the given name.

Parameters

name	The column name.

Definition at line 761 of file KineticaType.cs.

◆ getColumn() \[4/4]

Column kinetica.KineticaType.getColumn

(

string

name

)

inline

Gets the column with the given name.

Parameters

name	The column name.

Definition at line 761 of file KineticaType.cs.

◆ getColumnCount() \[1/2]

int kinetica.KineticaType.getColumnCount

(

)

inline

Gets the number of columns in the type.

Definition at line 763 of file KineticaType.cs.

◆ getColumnCount() \[2/2]

int kinetica.KineticaType.getColumnCount

(

)

inline

Gets the number of columns in the type.

Definition at line 763 of file KineticaType.cs.

◆ getColumnIndex() \[1/2]

int kinetica.KineticaType.getColumnIndex

(

string

name

)

inline

Gets the zero-based index of the column with the given name.

Parameters

name	The column name.

Definition at line 766 of file KineticaType.cs.

◆ getColumnIndex() \[2/2]

int kinetica.KineticaType.getColumnIndex

(

string

name

)

inline

Gets the zero-based index of the column with the given name.

Parameters

name	The column name.

Definition at line 777 of file KineticaType.cs.

◆ hasColumn() \[1/2]

bool kinetica.KineticaType.hasColumn

(

string

name

)

inline

Determines whether the type contains a column with the given name.

Parameters

name	The column name.

Definition at line 769 of file KineticaType.cs.

◆ hasColumn() \[2/2]

bool kinetica.KineticaType.hasColumn

(

string

name

)

inline

Determines whether the type contains a column with the given name.

Parameters

name	The column name.

Definition at line 769 of file KineticaType.cs.

◆ saveSourceType() \[1/2]

void kinetica.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 783 of file KineticaType.cs.

◆ saveSourceType() \[2/2]

void kinetica.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 783 of file KineticaType.cs.

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

\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/KineticaType.cs
Kinetica/KineticaType.cs

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KineticaType() \[1/10]

◆ KineticaType() \[2/10]

◆ KineticaType() \[3/10]

◆ KineticaType() \[4/10]

◆ KineticaType() \[5/10]

◆ KineticaType() \[6/10]

◆ KineticaType() \[7/10]

◆ KineticaType() \[8/10]

◆ KineticaType() \[9/10]

◆ KineticaType() \[10/10]

Member Function Documentation

◆ create() \[1/2]

◆ create() \[2/2]

◆ fromClass() \[1/4]

◆ fromClass() \[2/4]

◆ fromClass() \[3/4]

◆ fromClass() \[4/4]

◆ fromDynamicSchema() \[1/2]

◆ fromDynamicSchema() \[2/2]

◆ fromObject() \[1/4]

◆ fromObject() \[2/4]

◆ fromObject() \[3/4]

◆ fromObject() \[4/4]

◆ fromTable() \[1/2]

◆ fromTable() \[2/2]

◆ fromTypeID() \[1/2]

◆ fromTypeID() \[2/2]

◆ getColumn() \[1/4]

◆ getColumn() \[2/4]

◆ getColumn() \[3/4]

◆ getColumn() \[4/4]

◆ getColumnCount() \[1/2]

◆ getColumnCount() \[2/2]

◆ getColumnIndex() \[1/2]

◆ getColumnIndex() \[2/2]

◆ getColumns() \[1/2]

◆ getColumns() \[2/2]

◆ getLabel() \[1/2]

◆ getLabel() \[2/2]

◆ getSchema() \[1/2]

◆ getSchema() \[2/2]

◆ getSchemaString() \[1/2]

◆ getSchemaString() \[2/2]

◆ getSourceType() \[1/2]

◆ getSourceType() \[2/2]

◆ getTypeID() \[1/2]

◆ getTypeID() \[2/2]

◆ hasColumn() \[1/2]

◆ hasColumn() \[2/2]

◆ saveSourceType() \[1/2]

◆ saveSourceType() \[2/2]