kinetica.Records - Kinetica Docs

Classes
class	Column
	Immutable metadata about a column in a Kinetica type. More…

class	ColumnTypeExtensions
	Extension methods for ColumnType. More…

class	GenericRecord
	A generic record that can hold values for any Kinetica type. More…

interface	IBulkInsertable
	Combined interface for records that support bulk insertion with shard-aware routing. More…

interface	IKineticaRecord
	Interface for records that can be inserted into Kinetica. More…

interface	IKineticaRecordType< T >
	Static interface for type-level properties. More…

interface	IShardKeyExtractor
	Interface for extracting shard key values from a record. More…

class	RecordKey
	A binary key used for shard routing. More…

class	RecordKeyBuilder
	Builds RecordKey objects from ShardKeyValues for routing. More…

struct	RecordValue
	A typed value that can be stored in a GenericRecord. More…

struct	ShardKeyValue
	A typed value for shard key computation. More…

struct	ShardKeyValues
	Collection of shard key column names and values. More…

class	Type
	Immutable collection of metadata about a Kinetica type. More…

class	TypeBuilder
	Builder for constructing a Type with a fluent API. More…

Enumerations
enum	ColumnBaseType Integer , Long , Float , Double , String , Bytes , Integer , Long , Float , Double , String , Bytes
	Base column types that map to Avro primitive types. More…

enum	ColumnType Integer , Long , Float , Double , String , Bytes , Boolean , Int8 , Int16 , Timestamp , Date , DateTime , Time , Decimal , Ipv4 , Uuid , Char1 , Char2 , Char4 , Char8 , Char16 , Char32 , Char64 , Char128 , Char256 , Wkt , Array , Vector , Json , Integer , Long , Float , Double , String , Bytes , Boolean , Int8 , Int16 , Timestamp , Date , DateTime , Time , Decimal , Ipv4 , Uuid , Char1 , Char2 , Char4 , Char8 , Char16 , Char32 , Char64 , Char128 , Char256 , Wkt , Array , Vector , Json
	Column types including subtypes determined by properties. More…

enum	RecordValueType Null , Int , Long , Float , Double , String , Bytes , Null , Int , Long , Float , Double , String , Bytes
	Represents the type of a record value. More…

enum	ShardKeyValueType Null , Int , Long , Float , Double , String , Date , DateTime , Time , Ipv4 , Decimal , Boolean , Int8 , Int16 , Timestamp , Uuid , Ulong , Null , Int , Long , Float , Double , String , Date , DateTime , Time , Ipv4 , Decimal , Boolean , Int8 , Int16 , Timestamp , Uuid , Ulong
	Represents the type of a shard key value. More…

enum	ColumnBaseType Integer , Long , Float , Double , String , Bytes , Integer , Long , Float , Double , String , Bytes
	Base column types that map to Avro primitive types. More…

enum	ColumnType Integer , Long , Float , Double , String , Bytes , Boolean , Int8 , Int16 , Timestamp , Date , DateTime , Time , Decimal , Ipv4 , Uuid , Char1 , Char2 , Char4 , Char8 , Char16 , Char32 , Char64 , Char128 , Char256 , Wkt , Array , Vector , Json , Integer , Long , Float , Double , String , Bytes , Boolean , Int8 , Int16 , Timestamp , Date , DateTime , Time , Decimal , Ipv4 , Uuid , Char1 , Char2 , Char4 , Char8 , Char16 , Char32 , Char64 , Char128 , Char256 , Wkt , Array , Vector , Json
	Column types including subtypes determined by properties. More…

enum	RecordValueType Null , Int , Long , Float , Double , String , Bytes , Null , Int , Long , Float , Double , String , Bytes
	Represents the type of a record value. More…

enum	ShardKeyValueType Null , Int , Long , Float , Double , String , Date , DateTime , Time , Ipv4 , Decimal , Boolean , Int8 , Int16 , Timestamp , Uuid , Ulong , Null , Int , Long , Float , Double , String , Date , DateTime , Time , Ipv4 , Decimal , Boolean , Int8 , Int16 , Timestamp , Uuid , Ulong
	Represents the type of a shard key value. More…

Enumeration Type Documentation

◆ ColumnBaseType [1/2]

enum kinetica.Records.ColumnBaseType

Base column types that map to Avro primitive types.

Equivalent to Rust’s ColumnBaseType enum.

Enumerator
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.

Definition at line 7 of file ColumnType.cs.

◆ ColumnBaseType [2/2]

enum kinetica.Records.ColumnBaseType

Base column types that map to Avro primitive types.

Equivalent to Rust’s ColumnBaseType enum.

Enumerator
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.

Definition at line 7 of file ColumnType.cs.

◆ ColumnType [1/2]

enum kinetica.Records.ColumnType

Column types including subtypes determined by properties.

Equivalent to Rust’s ColumnType enum.

Enumerator
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Boolean	Boolean stored as integer (0 or 1)
Int8	8-bit signed integer
Int16	16-bit signed integer
Timestamp	Timestamp as milliseconds since Unix epoch.
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Decimal	Decimal number as string.
Ipv4	IPv4 address in dotted-quad format.
Uuid	UUID in standard format.
Char1	Fixed-length char(1)
Char2	Fixed-length char(2)
Char4	Fixed-length char(4)
Char8	Fixed-length char(8)
Char16	Fixed-length char(16)
Char32	Fixed-length char(32)
Char64	Fixed-length char(64)
Char128	Fixed-length char(128)
Char256	Fixed-length char(256)
Wkt	Well-Known Text geometry.
Array	Array type.
Vector	Vector type.
Json	JSON type.
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Boolean	Boolean stored as integer (0 or 1)
Int8	8-bit signed integer
Int16	16-bit signed integer
Timestamp	Timestamp as milliseconds since Unix epoch.
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Decimal	Decimal number as string.
Ipv4	IPv4 address in dotted-quad format.
Uuid	UUID in standard format.
Char1	Fixed-length char(1)
Char2	Fixed-length char(2)
Char4	Fixed-length char(4)
Char8	Fixed-length char(8)
Char16	Fixed-length char(16)
Char32	Fixed-length char(32)
Char64	Fixed-length char(64)
Char128	Fixed-length char(128)
Char256	Fixed-length char(256)
Wkt	Well-Known Text geometry.
Array	Array type.
Vector	Vector type.
Json	JSON type.

Definition at line 27 of file ColumnType.cs.

◆ ColumnType [2/2]

enum kinetica.Records.ColumnType

Column types including subtypes determined by properties.

Equivalent to Rust’s ColumnType enum.

Enumerator
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Boolean	Boolean stored as integer (0 or 1)
Int8	8-bit signed integer
Int16	16-bit signed integer
Timestamp	Timestamp as milliseconds since Unix epoch.
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Decimal	Decimal number as string.
Ipv4	IPv4 address in dotted-quad format.
Uuid	UUID in standard format.
Char1	Fixed-length char(1)
Char2	Fixed-length char(2)
Char4	Fixed-length char(4)
Char8	Fixed-length char(8)
Char16	Fixed-length char(16)
Char32	Fixed-length char(32)
Char64	Fixed-length char(64)
Char128	Fixed-length char(128)
Char256	Fixed-length char(256)
Wkt	Well-Known Text geometry.
Array	Array type.
Vector	Vector type.
Json	JSON type.
Integer	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string.
Bytes	Raw bytes.
Boolean	Boolean stored as integer (0 or 1)
Int8	8-bit signed integer
Int16	16-bit signed integer
Timestamp	Timestamp as milliseconds since Unix epoch.
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Decimal	Decimal number as string.
Ipv4	IPv4 address in dotted-quad format.
Uuid	UUID in standard format.
Char1	Fixed-length char(1)
Char2	Fixed-length char(2)
Char4	Fixed-length char(4)
Char8	Fixed-length char(8)
Char16	Fixed-length char(16)
Char32	Fixed-length char(32)
Char64	Fixed-length char(64)
Char128	Fixed-length char(128)
Char256	Fixed-length char(256)
Wkt	Well-Known Text geometry.
Array	Array type.
Vector	Vector type.
Json	JSON type.

Definition at line 27 of file ColumnType.cs.

◆ RecordValueType [1/2]

enum kinetica.Records.RecordValueType

Represents the type of a record value.

Equivalent to Rust’s RecordValue enum variants.

Enumerator
Null	Null value.
Int	32-bit signed integer (also used for boolean, int8, int16)
Long	64-bit signed integer (also used for timestamp)
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for date, time, datetime, char, uuid, ipv4, decimal)
Bytes	Raw bytes.
Null	Null value.
Int	32-bit signed integer (also used for boolean, int8, int16)
Long	64-bit signed integer (also used for timestamp)
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for date, time, datetime, char, uuid, ipv4, decimal)
Bytes	Raw bytes.

Definition at line 9 of file RecordValue.cs.

◆ RecordValueType [2/2]

enum kinetica.Records.RecordValueType

Represents the type of a record value.

Equivalent to Rust’s RecordValue enum variants.

Enumerator
Null	Null value.
Int	32-bit signed integer (also used for boolean, int8, int16)
Long	64-bit signed integer (also used for timestamp)
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for date, time, datetime, char, uuid, ipv4, decimal)
Bytes	Raw bytes.
Null	Null value.
Int	32-bit signed integer (also used for boolean, int8, int16)
Long	64-bit signed integer (also used for timestamp)
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for date, time, datetime, char, uuid, ipv4, decimal)
Bytes	Raw bytes.

Definition at line 9 of file RecordValue.cs.

◆ ShardKeyValueType [1/2]

enum kinetica.Records.ShardKeyValueType

Represents the type of a shard key value.

Equivalent to Rust’s ShardKeyValue enum variants.

Enumerator
Null	Null value.
Int	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for char(N) types)
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Ipv4	IPv4 address in dotted-quad format (e.g., “192.168.1.100”)
Decimal	Decimal as string (e.g., “12345.6789”)
Boolean	Boolean value.
Int8	8-bit signed integer (-128 to 127)
Int16	16-bit signed integer (-32768 to 32767)
Timestamp	Timestamp as milliseconds since Unix epoch.
Uuid	UUID in standard format (e.g., “550e8400-e29b-41d4-a716-446655440000”)
Ulong	Unsigned long as string (0 to 18446744073709551615)
Null	Null value.
Int	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for char(N) types)
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Ipv4	IPv4 address in dotted-quad format (e.g., “192.168.1.100”)
Decimal	Decimal as string (e.g., “12345.6789”)
Boolean	Boolean value.
Int8	8-bit signed integer (-128 to 127)
Int16	16-bit signed integer (-32768 to 32767)
Timestamp	Timestamp as milliseconds since Unix epoch.
Uuid	UUID in standard format (e.g., “550e8400-e29b-41d4-a716-446655440000”)
Ulong	Unsigned long as string (0 to 18446744073709551615)

Definition at line 10 of file ShardKeyValue.cs.

◆ ShardKeyValueType [2/2]

enum kinetica.Records.ShardKeyValueType

Represents the type of a shard key value.

Equivalent to Rust’s ShardKeyValue enum variants.

Enumerator
Null	Null value.
Int	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for char(N) types)
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Ipv4	IPv4 address in dotted-quad format (e.g., “192.168.1.100”)
Decimal	Decimal as string (e.g., “12345.6789”)
Boolean	Boolean value.
Int8	8-bit signed integer (-128 to 127)
Int16	16-bit signed integer (-32768 to 32767)
Timestamp	Timestamp as milliseconds since Unix epoch.
Uuid	UUID in standard format (e.g., “550e8400-e29b-41d4-a716-446655440000”)
Ulong	Unsigned long as string (0 to 18446744073709551615)
Null	Null value.
Int	32-bit signed integer
Long	64-bit signed integer
Float	32-bit IEEE 754 float
Double	64-bit IEEE 754 double
String	UTF-8 string (also used for char(N) types)
Date	Date in YYYY-MM-DD format.
DateTime	DateTime in YYYY-MM-DD HH:MM:SS.mmm format.
Time	Time in HH:MM:SS.mmm format.
Ipv4	IPv4 address in dotted-quad format (e.g., “192.168.1.100”)
Decimal	Decimal as string (e.g., “12345.6789”)
Boolean	Boolean value.
Int8	8-bit signed integer (-128 to 127)
Int16	16-bit signed integer (-32768 to 32767)
Timestamp	Timestamp as milliseconds since Unix epoch.
Uuid	UUID in standard format (e.g., “550e8400-e29b-41d4-a716-446655440000”)
Ulong	Unsigned long as string (0 to 18446744073709551615)

Definition at line 10 of file ShardKeyValue.cs.

​ Classes

​ Enumerations

​Enumeration Type Documentation

​◆ ColumnBaseType [1/2]

​◆ ColumnBaseType [2/2]

​◆ ColumnType [1/2]

​◆ ColumnType [2/2]

​◆ RecordValueType [1/2]

​◆ RecordValueType [2/2]

​◆ ShardKeyValueType [1/2]

​◆ ShardKeyValueType [2/2]

Classes

Enumerations