Kinetica   C#   API  Version 7.2.3.1
TypeBuilder Class Reference

Builder for constructing a Type with a fluent API. More...

Public Member Functions

 TypeBuilder (string label)
 Creates a new TypeBuilder with the specified label. More...
 
TypeBuilder AddColumn (Column column)
 Adds a column with the specified type. More...
 
TypeBuilder AddIntColumn (string name)
 Adds an integer column. More...
 
TypeBuilder AddLongColumn (string name)
 Adds a long column. More...
 
TypeBuilder AddFloatColumn (string name)
 Adds a float column. More...
 
TypeBuilder AddDoubleColumn (string name)
 Adds a double column. More...
 
TypeBuilder AddStringColumn (string name)
 Adds a string column. More...
 
TypeBuilder AddBytesColumn (string name)
 Adds a bytes column. More...
 
TypeBuilder AddTimestampColumn (string name)
 Adds a timestamp column. More...
 
TypeBuilder AddDateColumn (string name)
 Adds a date column. More...
 
TypeBuilder AddDateTimeColumn (string name)
 Adds a datetime column. More...
 
TypeBuilder AddTimeColumn (string name)
 Adds a time column. More...
 
TypeBuilder AddBooleanColumn (string name)
 Adds a boolean column (stored as int). More...
 
TypeBuilder AddInt8Column (string name)
 Adds an int8 column. More...
 
TypeBuilder AddInt16Column (string name)
 Adds an int16 column. More...
 
TypeBuilder AddDecimalColumn (string name)
 Adds a decimal column. More...
 
TypeBuilder AddIpv4Column (string name)
 Adds an IPv4 column. More...
 
TypeBuilder AddUuidColumn (string name)
 Adds a UUID column. More...
 
TypeBuilder AddCharColumn (string name, int length)
 Adds a char(N) column. More...
 
TypeBuilder AddWktColumn (string name)
 Adds a WKT (Well-Known Text) geometry column. More...
 
TypeBuilder AddJsonColumn (string name)
 Adds a JSON column. More...
 
TypeBuilder PrimaryKey ()
 Marks the current column as primary key. More...
 
TypeBuilder ShardKey ()
 Marks the current column as shard key. More...
 
TypeBuilder Nullable ()
 Marks the current column as nullable. More...
 
TypeBuilder Data ()
 Marks the current column as data column. More...
 
TypeBuilder WithProperty (string property)
 Adds a custom property to the current column. More...
 
Type Build ()
 Builds the Type. More...
 

Detailed Description

Builder for constructing a Type with a fluent API.

Equivalent to Rust's TypeBuilder.

var recordType = Type.Builder("sensor_reading")
.AddStringColumn("sensor_name")
.AddDoubleColumn("value")
.AddLongColumn("timestamp").Nullable()
.Build();

Definition at line 21 of file TypeBuilder.cs.

Constructor & Destructor Documentation

◆ TypeBuilder()

TypeBuilder.TypeBuilder ( string  label)
inline

Creates a new TypeBuilder with the specified label.

Parameters
labelThe type label/name.

Definition at line 31 of file TypeBuilder.cs.

Member Function Documentation

◆ AddBooleanColumn()

TypeBuilder TypeBuilder.AddBooleanColumn ( string  name)
inline

Adds a boolean column (stored as int).

Definition at line 163 of file TypeBuilder.cs.

◆ AddBytesColumn()

TypeBuilder TypeBuilder.AddBytesColumn ( string  name)
inline

Adds a bytes column.

Definition at line 113 of file TypeBuilder.cs.

◆ AddCharColumn()

TypeBuilder TypeBuilder.AddCharColumn ( string  name,
int  length 
)
inline

Adds a char(N) column.

Parameters
nameThe column name.
lengthThe character length (1, 2, 4, 8, 16, 32, 64, 128, or 256).

Definition at line 225 of file TypeBuilder.cs.

◆ AddColumn()

TypeBuilder TypeBuilder.AddColumn ( Column  column)
inline

Adds a column with the specified type.

Definition at line 53 of file TypeBuilder.cs.

◆ AddDateColumn()

TypeBuilder TypeBuilder.AddDateColumn ( string  name)
inline

Adds a date column.

Definition at line 133 of file TypeBuilder.cs.

◆ AddDateTimeColumn()

TypeBuilder TypeBuilder.AddDateTimeColumn ( string  name)
inline

Adds a datetime column.

Definition at line 143 of file TypeBuilder.cs.

◆ AddDecimalColumn()

TypeBuilder TypeBuilder.AddDecimalColumn ( string  name)
inline

Adds a decimal column.

Definition at line 193 of file TypeBuilder.cs.

◆ AddDoubleColumn()

TypeBuilder TypeBuilder.AddDoubleColumn ( string  name)
inline

Adds a double column.

Definition at line 93 of file TypeBuilder.cs.

◆ AddFloatColumn()

TypeBuilder TypeBuilder.AddFloatColumn ( string  name)
inline

Adds a float column.

Definition at line 83 of file TypeBuilder.cs.

◆ AddInt16Column()

TypeBuilder TypeBuilder.AddInt16Column ( string  name)
inline

Adds an int16 column.

Definition at line 183 of file TypeBuilder.cs.

◆ AddInt8Column()

TypeBuilder TypeBuilder.AddInt8Column ( string  name)
inline

Adds an int8 column.

Definition at line 173 of file TypeBuilder.cs.

◆ AddIntColumn()

TypeBuilder TypeBuilder.AddIntColumn ( string  name)
inline

Adds an integer column.

Definition at line 63 of file TypeBuilder.cs.

◆ AddIpv4Column()

TypeBuilder TypeBuilder.AddIpv4Column ( string  name)
inline

Adds an IPv4 column.

Definition at line 203 of file TypeBuilder.cs.

◆ AddJsonColumn()

TypeBuilder TypeBuilder.AddJsonColumn ( string  name)
inline

Adds a JSON column.

Definition at line 258 of file TypeBuilder.cs.

◆ AddLongColumn()

TypeBuilder TypeBuilder.AddLongColumn ( string  name)
inline

Adds a long column.

Definition at line 73 of file TypeBuilder.cs.

◆ AddStringColumn()

TypeBuilder TypeBuilder.AddStringColumn ( string  name)
inline

Adds a string column.

Definition at line 103 of file TypeBuilder.cs.

◆ AddTimeColumn()

TypeBuilder TypeBuilder.AddTimeColumn ( string  name)
inline

Adds a time column.

Definition at line 153 of file TypeBuilder.cs.

◆ AddTimestampColumn()

TypeBuilder TypeBuilder.AddTimestampColumn ( string  name)
inline

Adds a timestamp column.

Definition at line 123 of file TypeBuilder.cs.

◆ AddUuidColumn()

TypeBuilder TypeBuilder.AddUuidColumn ( string  name)
inline

Adds a UUID column.

Definition at line 213 of file TypeBuilder.cs.

◆ AddWktColumn()

TypeBuilder TypeBuilder.AddWktColumn ( string  name)
inline

Adds a WKT (Well-Known Text) geometry column.

Definition at line 248 of file TypeBuilder.cs.

◆ Build()

Type TypeBuilder.Build ( )
inline

Builds the Type.

Returns
A new Type instance.

Definition at line 352 of file TypeBuilder.cs.

◆ Data()

TypeBuilder TypeBuilder.Data ( )
inline

Marks the current column as data column.

Definition at line 317 of file TypeBuilder.cs.

◆ Nullable()

TypeBuilder TypeBuilder.Nullable ( )
inline

Marks the current column as nullable.

Definition at line 302 of file TypeBuilder.cs.

◆ PrimaryKey()

TypeBuilder TypeBuilder.PrimaryKey ( )
inline

Marks the current column as primary key.

Definition at line 272 of file TypeBuilder.cs.

◆ ShardKey()

TypeBuilder TypeBuilder.ShardKey ( )
inline

Marks the current column as shard key.

Definition at line 287 of file TypeBuilder.cs.

◆ WithProperty()

TypeBuilder TypeBuilder.WithProperty ( string  property)
inline

Adds a custom property to the current column.

Definition at line 332 of file TypeBuilder.cs.


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