Builder for constructing type properties dictionaries. More...

Public Member Functions
	TypePropertiesBuilder ()
	Creates a new TypePropertiesBuilder. More...

TypePropertiesBuilder	Column (string name, KineticaColumnProperties props)
	Adds properties for a column. More...

TypePropertiesBuilder	ColumnProperty (string name, string property)
	Adds a single property to a column. More...

TypePropertiesBuilder	PrimaryKey (string name)
	Marks a column as primary key. More...

TypePropertiesBuilder	ShardKey (string name)
	Marks a column as shard key. More...

TypePropertiesBuilder	Nullable (string name)
	Marks a column as nullable. More...

TypePropertiesBuilder	Timestamp (string name)
	Marks a column as timestamp type. More...

TypePropertiesBuilder	Data (string name)
	Marks a column as data column (text search enabled). More...

TypePropertiesBuilder	Ipv4 (string name)
	Marks a column as IPv4 type. More...

TypePropertiesBuilder	Date (string name)
	Marks a column as date type. More...

TypePropertiesBuilder	DateTime (string name)
	Marks a column as datetime type. More...

TypePropertiesBuilder	Time (string name)
	Marks a column as time type. More...

TypePropertiesBuilder	Decimal (string name)
	Marks a column as decimal type. More...

TypePropertiesBuilder	Uuid (string name)
	Marks a column as UUID type. More...

TypePropertiesBuilder	Boolean (string name)
	Marks a column as boolean type. More...

TypePropertiesBuilder	Int8 (string name)
	Marks a column as int8 type. More...

TypePropertiesBuilder	Int16 (string name)
	Marks a column as int16 type. More...

TypePropertiesBuilder	Wkt (string name)
	Marks a column as WKT (geometry) type. More...

TypePropertiesBuilder	CharN (string name, int n)
	Marks a column as char(N) type. More...

IReadOnlyDictionary< string, IList< string > >	Build ()
	Builds the properties dictionary. More...

Detailed Description

Builder for constructing type properties dictionaries.

Equivalent to Rust's TypePropertiesBuilder.

var properties = new TypePropertiesBuilder()
    .Column("id", new KineticaColumnProperties().PrimaryKey().ShardKey())
    .Timestamp("created_at")
    .Data("description")
    .Build();

Definition at line 20 of file TypePropertiesBuilder.cs.

Constructor & Destructor Documentation

◆ TypePropertiesBuilder()

TypePropertiesBuilder.TypePropertiesBuilder ( )

inline

Creates a new TypePropertiesBuilder.

Definition at line 27 of file TypePropertiesBuilder.cs.

Member Function Documentation

◆ Boolean()

TypePropertiesBuilder TypePropertiesBuilder.Boolean ( string name )

inline

Marks a column as boolean type.

Definition at line 153 of file TypePropertiesBuilder.cs.

◆ Build()

IReadOnlyDictionary<string, IList<string> > TypePropertiesBuilder.Build ( )

inline

Builds the properties dictionary.

Definition at line 206 of file TypePropertiesBuilder.cs.

◆ CharN()

TypePropertiesBuilder TypePropertiesBuilder.CharN	(	string	name,
		int	n
	)

inline

Marks a column as char(N) type.

Definition at line 185 of file TypePropertiesBuilder.cs.

◆ Column()

TypePropertiesBuilder TypePropertiesBuilder.Column	(	string	name,
		KineticaColumnProperties	props
	)

inline

Adds properties for a column.

Parameters

name	The column name.
props	The column properties builder.

Definition at line 37 of file TypePropertiesBuilder.cs.

◆ ColumnProperty()

TypePropertiesBuilder TypePropertiesBuilder.ColumnProperty	(	string	name,
		string	property
	)

inline

Adds a single property to a column.

Parameters

name	The column name.
property	The property to add.

Definition at line 48 of file TypePropertiesBuilder.cs.

◆ Data()

TypePropertiesBuilder TypePropertiesBuilder.Data ( string name )

inline

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

Definition at line 97 of file TypePropertiesBuilder.cs.

◆ Date()

TypePropertiesBuilder TypePropertiesBuilder.Date ( string name )

inline

Marks a column as date type.

Definition at line 113 of file TypePropertiesBuilder.cs.

◆ DateTime()

TypePropertiesBuilder TypePropertiesBuilder.DateTime ( string name )

inline

Marks a column as datetime type.

Definition at line 121 of file TypePropertiesBuilder.cs.

◆ Decimal()

TypePropertiesBuilder TypePropertiesBuilder.Decimal ( string name )

inline

Marks a column as decimal type.

Definition at line 137 of file TypePropertiesBuilder.cs.

◆ Int16()

TypePropertiesBuilder TypePropertiesBuilder.Int16 ( string name )

inline

Marks a column as int16 type.

Definition at line 169 of file TypePropertiesBuilder.cs.

◆ Int8()

TypePropertiesBuilder TypePropertiesBuilder.Int8 ( string name )

inline

Marks a column as int8 type.

Definition at line 161 of file TypePropertiesBuilder.cs.

◆ Ipv4()

TypePropertiesBuilder TypePropertiesBuilder.Ipv4 ( string name )

inline

Marks a column as IPv4 type.

Definition at line 105 of file TypePropertiesBuilder.cs.

◆ Nullable()

TypePropertiesBuilder TypePropertiesBuilder.Nullable ( string name )

inline

Marks a column as nullable.

Definition at line 81 of file TypePropertiesBuilder.cs.

◆ PrimaryKey()

TypePropertiesBuilder TypePropertiesBuilder.PrimaryKey ( string name )

inline

Marks a column as primary key.

Definition at line 65 of file TypePropertiesBuilder.cs.

◆ ShardKey()

TypePropertiesBuilder TypePropertiesBuilder.ShardKey ( string name )

inline

Marks a column as shard key.

Definition at line 73 of file TypePropertiesBuilder.cs.

◆ Time()

TypePropertiesBuilder TypePropertiesBuilder.Time ( string name )

inline

Marks a column as time type.

Definition at line 129 of file TypePropertiesBuilder.cs.

◆ Timestamp()

TypePropertiesBuilder TypePropertiesBuilder.Timestamp ( string name )

inline

Marks a column as timestamp type.

Definition at line 89 of file TypePropertiesBuilder.cs.

◆ Uuid()

TypePropertiesBuilder TypePropertiesBuilder.Uuid ( string name )

inline

Marks a column as UUID type.

Definition at line 145 of file TypePropertiesBuilder.cs.

◆ Wkt()

TypePropertiesBuilder TypePropertiesBuilder.Wkt ( string name )

inline

Marks a column as WKT (geometry) type.

Definition at line 177 of file TypePropertiesBuilder.cs.

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

Kinetica/SchemaBuilder/TypePropertiesBuilder.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TypePropertiesBuilder()

Member Function Documentation

◆ Boolean()

◆ Build()

◆ CharN()

◆ Column()

◆ ColumnProperty()

◆ Data()

◆ Date()

◆ DateTime()

◆ Decimal()

◆ Int16()

◆ Int8()

◆ Ipv4()

◆ Nullable()

◆ PrimaryKey()

◆ ShardKey()

◆ Time()

◆ Timestamp()

◆ Uuid()

◆ Wkt()