Kinetica   C#   API  Version 7.2.3.1
KineticaColumnProperties Class Reference

Builder for Kinetica column properties. More...

Public Member Functions

 KineticaColumnProperties ()
 Creates a new KineticaColumnProperties builder. More...
 
KineticaColumnProperties PrimaryKey ()
 Marks the column as a primary key. More...
 
KineticaColumnProperties ShardKey ()
 Marks the column as a shard key. More...
 
KineticaColumnProperties Nullable ()
 Marks the column as nullable. More...
 
KineticaColumnProperties Timestamp ()
 Marks the column as a timestamp type. More...
 
KineticaColumnProperties Data ()
 Marks the column as a data column (text search enabled). More...
 
KineticaColumnProperties Ipv4 ()
 Marks the column as an IPv4 type. More...
 
KineticaColumnProperties Wkt ()
 Marks the column as a WKT (Well-Known Text) geometry type. More...
 
KineticaColumnProperties CharN (int n)
 Marks the column as a char(N) type. More...
 
KineticaColumnProperties Int8 ()
 Marks the column as an int8 type. More...
 
KineticaColumnProperties Int16 ()
 Marks the column as an int16 type. More...
 
KineticaColumnProperties Date ()
 Marks the column as a date type. More...
 
KineticaColumnProperties Time ()
 Marks the column as a time type. More...
 
KineticaColumnProperties DateTime ()
 Marks the column as a datetime type. More...
 
KineticaColumnProperties Decimal ()
 Marks the column as a decimal type. More...
 
KineticaColumnProperties Uuid ()
 Marks the column as a UUID type. More...
 
KineticaColumnProperties Ulong ()
 Marks the column as an unsigned long type. More...
 
KineticaColumnProperties Boolean ()
 Marks the column as a boolean type. More...
 
KineticaColumnProperties Json ()
 Marks the column as a JSON type. More...
 
KineticaColumnProperties Array ()
 Marks the column as an array type. More...
 
KineticaColumnProperties Vector ()
 Marks the column as a vector type. More...
 
KineticaColumnProperties Property (string property)
 Adds a custom property. More...
 
IList< string > Build ()
 Builds the list of properties. More...
 

Detailed Description

Builder for Kinetica column properties.

Equivalent to Rust's KineticaColumnProperties.

var props = new KineticaColumnProperties()
.PrimaryKey()
.ShardKey()
.Build();
// Or for specific column types:
var timestampProps = new KineticaColumnProperties()
.Timestamp()
.Nullable()
.Build();

Definition at line 25 of file KineticaColumnProperties.cs.

Constructor & Destructor Documentation

◆ KineticaColumnProperties()

KineticaColumnProperties.KineticaColumnProperties ( )
inline

Creates a new KineticaColumnProperties builder.

Definition at line 32 of file KineticaColumnProperties.cs.

Member Function Documentation

◆ Array()

KineticaColumnProperties KineticaColumnProperties.Array ( )
inline

Marks the column as an array type.

Definition at line 216 of file KineticaColumnProperties.cs.

◆ Boolean()

KineticaColumnProperties KineticaColumnProperties.Boolean ( )
inline

Marks the column as a boolean type.

Definition at line 198 of file KineticaColumnProperties.cs.

◆ Build()

IList<string> KineticaColumnProperties.Build ( )
inline

Builds the list of properties.

Definition at line 244 of file KineticaColumnProperties.cs.

◆ CharN()

KineticaColumnProperties KineticaColumnProperties.CharN ( int  n)
inline

Marks the column as a char(N) type.

Parameters
nThe character length (1, 2, 4, 8, 16, 32, 64, 128, or 256).

Definition at line 104 of file KineticaColumnProperties.cs.

◆ Data()

KineticaColumnProperties KineticaColumnProperties.Data ( )
inline

Marks the column as a data column (text search enabled).

Definition at line 76 of file KineticaColumnProperties.cs.

◆ Date()

KineticaColumnProperties KineticaColumnProperties.Date ( )
inline

Marks the column as a date type.

Definition at line 144 of file KineticaColumnProperties.cs.

◆ DateTime()

KineticaColumnProperties KineticaColumnProperties.DateTime ( )
inline

Marks the column as a datetime type.

Definition at line 162 of file KineticaColumnProperties.cs.

◆ Decimal()

KineticaColumnProperties KineticaColumnProperties.Decimal ( )
inline

Marks the column as a decimal type.

Definition at line 171 of file KineticaColumnProperties.cs.

◆ Int16()

KineticaColumnProperties KineticaColumnProperties.Int16 ( )
inline

Marks the column as an int16 type.

Definition at line 135 of file KineticaColumnProperties.cs.

◆ Int8()

KineticaColumnProperties KineticaColumnProperties.Int8 ( )
inline

Marks the column as an int8 type.

Definition at line 126 of file KineticaColumnProperties.cs.

◆ Ipv4()

KineticaColumnProperties KineticaColumnProperties.Ipv4 ( )
inline

Marks the column as an IPv4 type.

Definition at line 85 of file KineticaColumnProperties.cs.

◆ Json()

KineticaColumnProperties KineticaColumnProperties.Json ( )
inline

Marks the column as a JSON type.

Definition at line 207 of file KineticaColumnProperties.cs.

◆ Nullable()

KineticaColumnProperties KineticaColumnProperties.Nullable ( )
inline

Marks the column as nullable.

Definition at line 58 of file KineticaColumnProperties.cs.

◆ PrimaryKey()

KineticaColumnProperties KineticaColumnProperties.PrimaryKey ( )
inline

Marks the column as a primary key.

Definition at line 40 of file KineticaColumnProperties.cs.

◆ Property()

KineticaColumnProperties KineticaColumnProperties.Property ( string  property)
inline

Adds a custom property.

Definition at line 234 of file KineticaColumnProperties.cs.

◆ ShardKey()

KineticaColumnProperties KineticaColumnProperties.ShardKey ( )
inline

Marks the column as a shard key.

Definition at line 49 of file KineticaColumnProperties.cs.

◆ Time()

KineticaColumnProperties KineticaColumnProperties.Time ( )
inline

Marks the column as a time type.

Definition at line 153 of file KineticaColumnProperties.cs.

◆ Timestamp()

KineticaColumnProperties KineticaColumnProperties.Timestamp ( )
inline

Marks the column as a timestamp type.

Definition at line 67 of file KineticaColumnProperties.cs.

◆ Ulong()

KineticaColumnProperties KineticaColumnProperties.Ulong ( )
inline

Marks the column as an unsigned long type.

Definition at line 189 of file KineticaColumnProperties.cs.

◆ Uuid()

KineticaColumnProperties KineticaColumnProperties.Uuid ( )
inline

Marks the column as a UUID type.

Definition at line 180 of file KineticaColumnProperties.cs.

◆ Vector()

KineticaColumnProperties KineticaColumnProperties.Vector ( )
inline

Marks the column as a vector type.

Definition at line 225 of file KineticaColumnProperties.cs.

◆ Wkt()

KineticaColumnProperties KineticaColumnProperties.Wkt ( )
inline

Marks the column as a WKT (Well-Known Text) geometry type.

Definition at line 94 of file KineticaColumnProperties.cs.


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