kinetica.Records.Column - Kinetica Docs

Immutable metadata about a column in a Kinetica type. More…

Public Member Functions
	Column (string name, ColumnType columnType)
	Creates a new column with the given name and type.

	Column (string name, ColumnType columnType, IEnumerable< string > properties)
	Creates a new column with the given name, type, and properties.

Column	WithAddedProperties (params string[] additionalProperties)
	Creates a copy of this column with the specified properties added.

Column	AsNullable ()
	Creates a copy of this column marked as nullable.

Column	AsPrimaryKey ()
	Creates a copy of this column marked as primary key.

Column	AsShardKey ()
	Creates a copy of this column marked as shard key.

override string	ToString ()

override bool	Equals (object? obj)

override int	GetHashCode ()

	Column (string name, ColumnType columnType)
	Creates a new column with the given name and type.

	Column (string name, ColumnType columnType, IEnumerable< string > properties)
	Creates a new column with the given name, type, and properties.

Column	WithAddedProperties (params string[] additionalProperties)
	Creates a copy of this column with the specified properties added.

Column	AsNullable ()
	Creates a copy of this column marked as nullable.

Column	AsPrimaryKey ()
	Creates a copy of this column marked as primary key.

Column	AsShardKey ()
	Creates a copy of this column marked as shard key.

override string	ToString ()

override bool	Equals (object? obj)

override int	GetHashCode ()

Static Public Member Functions
static Column	WithProperties (string name, ColumnType columnType, IEnumerable< string > properties)
	Creates a column with properties from a list.

static Column	WithProperties (string name, ColumnType columnType, IEnumerable< string > properties)
	Creates a column with properties from a list.

Properties
string	Name `[get]`
	Gets the column name.

ColumnType	ColumnType `[get]`
	Gets the column type.

ColumnBaseType	BaseType `[get]`
	Gets the base type for this column.

IReadOnlyList< string >	Properties `[get]`
	Gets the column properties.

bool	IsNullable `[get]`
	Returns true if this column is nullable.

bool	IsPrimaryKey `[get]`
	Returns true if this column is a primary key.

bool	IsShardKey `[get]`
	Returns true if this column is a shard key.

string	AvroTypeName `[get]`
	Returns the Avro type name for this column.

Detailed Description

Immutable metadata about a column in a Kinetica type.

Equivalent to Rust’s Column struct.

Definition at line 7 of file Column.cs.

Constructor & Destructor Documentation

◆ Column() [1/4]

kinetica.Records.Column.Column	(	string	name,
		ColumnType	columnType )

inline

Creates a new column with the given name and type.

Parameters

name	The column name.
columnType	The column type.

Definition at line 21 of file Column.cs.

◆ Column() [2/4]

kinetica.Records.Column.Column	(	string	name,
		ColumnType	columnType,
		IEnumerable< string >	properties )

inline

Creates a new column with the given name, type, and properties.

Parameters

name	The column name.
columnType	The column type.
properties	The column properties (e.g., “primary_key”, “shard_key”, “nullable”).

Definition at line 32 of file Column.cs.

◆ Column() [3/4]

kinetica.Records.Column.Column	(	string	name,
		ColumnType	columnType )

inline

Creates a new column with the given name and type.

Parameters

name	The column name.
columnType	The column type.

Definition at line 21 of file Column.cs.

◆ Column() [4/4]

kinetica.Records.Column.Column	(	string	name,
		ColumnType	columnType,
		IEnumerable< string >	properties )

inline

Creates a new column with the given name, type, and properties.

Parameters

name	The column name.
columnType	The column type.
properties	The column properties (e.g., “primary_key”, “shard_key”, “nullable”).

Definition at line 32 of file Column.cs.

Member Function Documentation

◆ AsNullable() [1/2]

Column kinetica.Records.Column.AsNullable ( )

inline

Creates a copy of this column marked as nullable.

Definition at line 87 of file Column.cs.

◆ AsNullable() [2/2]

Column kinetica.Records.Column.AsNullable ( )

inline

Creates a copy of this column marked as nullable.

Definition at line 87 of file Column.cs.

◆ AsPrimaryKey() [1/2]

Column kinetica.Records.Column.AsPrimaryKey ( )

inline

Creates a copy of this column marked as primary key.

Definition at line 96 of file Column.cs.

◆ AsPrimaryKey() [2/2]

Column kinetica.Records.Column.AsPrimaryKey ( )

inline

Creates a copy of this column marked as primary key.

Definition at line 96 of file Column.cs.

◆ AsShardKey() [1/2]

Column kinetica.Records.Column.AsShardKey ( )

inline

Creates a copy of this column marked as shard key.

Definition at line 105 of file Column.cs.

◆ AsShardKey() [2/2]

Column kinetica.Records.Column.AsShardKey ( )

inline

Creates a copy of this column marked as shard key.

Definition at line 105 of file Column.cs.

◆ Equals() [1/2]

override bool kinetica.Records.Column.Equals ( object? obj )

inline

Definition at line 119 of file Column.cs.

◆ Equals() [2/2]

override bool kinetica.Records.Column.Equals ( object? obj )

inline

Definition at line 119 of file Column.cs.

◆ GetHashCode() [1/2]

override int kinetica.Records.Column.GetHashCode ( )

inline

Definition at line 128 of file Column.cs.

◆ GetHashCode() [2/2]

override int kinetica.Records.Column.GetHashCode ( )

inline

Definition at line 128 of file Column.cs.

◆ ToString() [1/2]

override string kinetica.Records.Column.ToString ( )

inline

Definition at line 112 of file Column.cs.

◆ ToString() [2/2]

override string kinetica.Records.Column.ToString ( )

inline

Definition at line 112 of file Column.cs.

◆ WithAddedProperties() [1/2]

Column kinetica.Records.Column.WithAddedProperties ( params string[] additionalProperties )

inline

Creates a copy of this column with the specified properties added.

Definition at line 78 of file Column.cs.

◆ WithAddedProperties() [2/2]

Column kinetica.Records.Column.WithAddedProperties ( params string[] additionalProperties )

inline

Creates a copy of this column with the specified properties added.

Definition at line 78 of file Column.cs.

◆ WithProperties() [1/2]

static Column kinetica.Records.Column.WithProperties	(	string	name,
		ColumnType	columnType,
		IEnumerable< string >	properties )

static

Creates a column with properties from a list.

Equivalent to Rust’s Column::with_properties().

◆ WithProperties() [2/2]

static Column kinetica.Records.Column.WithProperties	(	string	name,
		ColumnType	columnType,
		IEnumerable< string >	properties )

static

Creates a column with properties from a list.

Equivalent to Rust’s Column::with_properties().

Property Documentation

◆ AvroTypeName

string kinetica.Records.Column.AvroTypeName

get

Returns the Avro type name for this column.

Definition at line 73 of file Column.cs.

◆ BaseType

ColumnBaseType kinetica.Records.Column.BaseType

get

Gets the base type for this column.

Definition at line 56 of file Column.cs.

◆ ColumnType

ColumnType kinetica.Records.Column.ColumnType

get

Gets the column type.

Definition at line 53 of file Column.cs.

◆ IsNullable

bool kinetica.Records.Column.IsNullable

get

Returns true if this column is nullable.

Definition at line 62 of file Column.cs.

◆ IsPrimaryKey

bool kinetica.Records.Column.IsPrimaryKey

get

Returns true if this column is a primary key.

Definition at line 65 of file Column.cs.

◆ IsShardKey

bool kinetica.Records.Column.IsShardKey

get

Returns true if this column is a shard key.

Definition at line 68 of file Column.cs.

◆ Name

string kinetica.Records.Column.Name

get

Gets the column name.

Definition at line 50 of file Column.cs.

◆ Properties

IReadOnlyList< string > kinetica.Records.Column.Properties

get

Gets the column properties.

Definition at line 59 of file Column.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/Records/Column.cs
Kinetica/Records/Column.cs

​ Public Member Functions

​ Static Public Member Functions

​ Properties

​Detailed Description

​Constructor & Destructor Documentation

​◆ Column() [1/4]

​◆ Column() [2/4]

​◆ Column() [3/4]

​◆ Column() [4/4]

​Member Function Documentation

​◆ AsNullable() [1/2]

​◆ AsNullable() [2/2]

​◆ AsPrimaryKey() [1/2]

​◆ AsPrimaryKey() [2/2]

​◆ AsShardKey() [1/2]

​◆ AsShardKey() [2/2]

​◆ Equals() [1/2]

​◆ Equals() [2/2]

​◆ GetHashCode() [1/2]

​◆ GetHashCode() [2/2]

​◆ ToString() [1/2]

​◆ ToString() [2/2]

​◆ WithAddedProperties() [1/2]

​◆ WithAddedProperties() [2/2]

​◆ WithProperties() [1/2]

​◆ WithProperties() [2/2]

​Property Documentation

​◆ AvroTypeName

​◆ BaseType

​◆ ColumnType

​◆ IsNullable

​◆ IsPrimaryKey

​◆ IsShardKey

​◆ Name

​◆ Properties

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Column() [1/4]

◆ Column() [2/4]

◆ Column() [3/4]

◆ Column() [4/4]

Member Function Documentation

◆ AsNullable() [1/2]

◆ AsNullable() [2/2]

◆ AsPrimaryKey() [1/2]

◆ AsPrimaryKey() [2/2]

◆ AsShardKey() [1/2]

◆ AsShardKey() [2/2]

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode() [1/2]

◆ GetHashCode() [2/2]

◆ ToString() [1/2]

◆ ToString() [2/2]

◆ WithAddedProperties() [1/2]

◆ WithAddedProperties() [2/2]

◆ WithProperties() [1/2]

◆ WithProperties() [2/2]

Property Documentation

◆ AvroTypeName

◆ BaseType

◆ ColumnType

◆ IsNullable

◆ IsPrimaryKey

◆ IsShardKey

◆ Name

◆ Properties