Kinetica   C#   API  Version 7.2.3.1
Kinetica.LoadGenerator.IngestRecord Class Reference

Basic ingest record schema matching the Rust IngestRecord. More...

+ Inheritance diagram for Kinetica.LoadGenerator.IngestRecord:
+ Collaboration diagram for Kinetica.LoadGenerator.IngestRecord:

Public Member Functions

override string ToString ()
 
ShardKeyValues GetShardKeyValues ()
 Returns shard key column names and their typed values. More...
 

Static Public Member Functions

static Dictionary< string, IList< string > > GetTypeProperties ()
 Gets the column properties for type creation. More...
 

Properties

long TimestampMillis [get, set]
 Timestamp in milliseconds since Unix epoch. More...
 
int Source [get, set]
 Source identifier (set to message_size for tracking payload size). More...
 
string Payload = string.Empty [get, set]
 Variable-size payload for measuring throughput with different record sizes. More...
 

Detailed Description

Basic ingest record schema matching the Rust IngestRecord.

Used for simple load generation with timestamp, source, and payload fields.

Definition at line 10 of file IngestRecord.cs.

Member Function Documentation

◆ GetShardKeyValues()

ShardKeyValues Kinetica.LoadGenerator.IngestRecord.GetShardKeyValues ( )
inline

Returns shard key column names and their typed values.

Only columns that are part of the shard key need to be included. The values are used for computing the routing hash to determine which worker node should receive the record.

For best performance, implement this method to avoid allocations when possible (e.g., use ShardKeyValues.Single() for single-column keys).

Returns
A collection of (column name, value) pairs for the shard key.

Implements IShardKeyExtractor.

Definition at line 43 of file IngestRecord.cs.

◆ GetTypeProperties()

static Dictionary<string, IList<string> > Kinetica.LoadGenerator.IngestRecord.GetTypeProperties ( )
static

Gets the column properties for type creation.

◆ ToString()

override string Kinetica.LoadGenerator.IngestRecord.ToString ( )

Property Documentation

◆ Payload

string Kinetica.LoadGenerator.IngestRecord.Payload = string.Empty
getset

Variable-size payload for measuring throughput with different record sizes.

Uses string type which is well-supported by Kinetica type system.

Definition at line 28 of file IngestRecord.cs.

◆ Source

int Kinetica.LoadGenerator.IngestRecord.Source
getset

Source identifier (set to message_size for tracking payload size).

Property: DATA

Definition at line 22 of file IngestRecord.cs.

◆ TimestampMillis

long Kinetica.LoadGenerator.IngestRecord.TimestampMillis
getset

Timestamp in milliseconds since Unix epoch.

Property: TIMESTAMP

Definition at line 16 of file IngestRecord.cs.


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