Column Class Reference

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. More...
	Column (string name, ColumnType columnType, IEnumerable< string > properties)
	Creates a new column with the given name, type, and properties. More...
Column	WithAddedProperties (params string[] additionalProperties)
	Creates a copy of this column with the specified properties added. More...
Column	AsNullable ()
	Creates a copy of this column marked as nullable. More...
Column	AsPrimaryKey ()
	Creates a copy of this column marked as primary key. More...
Column	AsShardKey ()
	Creates a copy of this column marked as shard key. More...
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. More...

Public Attributes
string	Name => _name
	Gets the column name. More...
ColumnType	ColumnType => _columnType
	Gets the column type. More...
ColumnBaseType	BaseType => _columnType.GetBaseType()
	Gets the base type for this column. More...
IReadOnlyList< string >	Properties => _properties
	Gets the column properties. More...
bool	IsNullable => _isNullable
	Returns true if this column is nullable. More...
bool	IsPrimaryKey => _isPrimaryKey
	Returns true if this column is a primary key. More...
bool	IsShardKey => _isShardKey
	Returns true if this column is a shard key. More...
string	AvroTypeName => _columnType.GetAvroTypeName()
	Returns the Avro type name for this column. More...

Detailed Description

Immutable metadata about a column in a Kinetica type.

Equivalent to Rust's Column struct.

Definition at line 11 of file Column.cs.

Constructor & Destructor Documentation

Column() [1/2]

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 25 of file Column.cs.

Column() [2/2]

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 36 of file Column.cs.

Member Function Documentation

AsNullable()

Column Column.AsNullable ( )

inline

Creates a copy of this column marked as nullable.

Definition at line 91 of file Column.cs.

AsPrimaryKey()

Column Column.AsPrimaryKey ( )

inline

Creates a copy of this column marked as primary key.

Definition at line 100 of file Column.cs.

AsShardKey()

Column Column.AsShardKey ( )

inline

Creates a copy of this column marked as shard key.

Definition at line 109 of file Column.cs.

Equals()

override bool Column.Equals ( object?  obj )

inline

Definition at line 121 of file Column.cs.

GetHashCode()

override int Column.GetHashCode ( )

inline

Definition at line 129 of file Column.cs.

ToString()

override string Column.ToString ( )

inline

Definition at line 115 of file Column.cs.

WithAddedProperties()

Column Column.WithAddedProperties ( params string []  additionalProperties )

inline

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

Definition at line 82 of file Column.cs.

WithProperties()

static Column 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().

Member Data Documentation

AvroTypeName

string Column.AvroTypeName => _columnType.GetAvroTypeName()

Returns the Avro type name for this column.

Definition at line 77 of file Column.cs.

BaseType

ColumnBaseType Column.BaseType => _columnType.GetBaseType()

Gets the base type for this column.

Definition at line 60 of file Column.cs.

ColumnType

ColumnType Column.ColumnType => _columnType

Gets the column type.

Definition at line 57 of file Column.cs.

IsNullable

bool Column.IsNullable => _isNullable

Returns true if this column is nullable.

Definition at line 66 of file Column.cs.

IsPrimaryKey

bool Column.IsPrimaryKey => _isPrimaryKey

Returns true if this column is a primary key.

Definition at line 69 of file Column.cs.

IsShardKey

bool Column.IsShardKey => _isShardKey

Returns true if this column is a shard key.

Definition at line 72 of file Column.cs.

Name

string Column.Name => _name

Gets the column name.

Definition at line 54 of file Column.cs.

Properties

IReadOnlyList<string> Column.Properties => _properties

Gets the column properties.

Definition at line 63 of file Column.cs.

---

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

• Kinetica/Records/Column.cs