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]
| inline |
Creates a new column with the given name and type.
| name | The column name. |
| columnType | The column type. |
Definition at line 21 of file Column.cs.
◆ Column() [2/4]
| inline |
Creates a new column with the given name, type, and properties.
| 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]
| inline |
Creates a new column with the given name and type.
| name | The column name. |
| columnType | The column type. |
Definition at line 21 of file Column.cs.
◆ Column() [4/4]
| inline |
Creates a new column with the given name, type, and properties.
| 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]
| inline |
Creates a copy of this column marked as nullable.
Definition at line 87 of file Column.cs.
◆ AsNullable() [2/2]
| inline |
Creates a copy of this column marked as nullable.
Definition at line 87 of file Column.cs.
◆ AsPrimaryKey() [1/2]
| inline |
Creates a copy of this column marked as primary key.
Definition at line 96 of file Column.cs.
◆ AsPrimaryKey() [2/2]
| inline |
Creates a copy of this column marked as primary key.
Definition at line 96 of file Column.cs.
◆ AsShardKey() [1/2]
| inline |
Creates a copy of this column marked as shard key.
Definition at line 105 of file Column.cs.
◆ AsShardKey() [2/2]
| inline |
Creates a copy of this column marked as shard key.
Definition at line 105 of file Column.cs.
◆ Equals() [1/2]
| inline |
Definition at line 119 of file Column.cs.
◆ Equals() [2/2]
| inline |
Definition at line 119 of file Column.cs.
◆ GetHashCode() [1/2]
| inline |
Definition at line 128 of file Column.cs.
◆ GetHashCode() [2/2]
| inline |
Definition at line 128 of file Column.cs.
◆ ToString() [1/2]
| inline |
Definition at line 112 of file Column.cs.
◆ ToString() [2/2]
| inline |
Definition at line 112 of file Column.cs.
◆ WithAddedProperties() [1/2]
| inline |
Creates a copy of this column with the specified properties added.
Definition at line 78 of file Column.cs.
◆ WithAddedProperties() [2/2]
| inline |
Creates a copy of this column with the specified properties added.
Definition at line 78 of file Column.cs.
◆ WithProperties() [1/2]
| static |
Creates a column with properties from a list.
Equivalent to Rust’s Column::with_properties().
◆ WithProperties() [2/2]
| static |
Creates a column with properties from a list.
Equivalent to Rust’s Column::with_properties().
Property Documentation
◆ AvroTypeName
| get |
Returns the Avro type name for this column.
Definition at line 73 of file Column.cs.
◆ BaseType
| get |
Gets the base type for this column.
Definition at line 56 of file Column.cs.
◆ ColumnType
| get |
Gets the column type.
Definition at line 53 of file Column.cs.
◆ IsNullable
| get |
Returns true if this column is nullable.
Definition at line 62 of file Column.cs.
◆ IsPrimaryKey
| get |
Returns true if this column is a primary key.
Definition at line 65 of file Column.cs.
◆ IsShardKey
| get |
Returns true if this column is a shard key.
Definition at line 68 of file Column.cs.
◆ Name
| get |
Gets the column name.
Definition at line 50 of file Column.cs.
◆ 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_centos8-arch_amd64-cc_gcc_8.5.0/install/Kinetica/Records/Column.cs
- Kinetica/Records/Column.cs