Skip to main content

Configuration options for the BulkInserter<T>. More…

​
Public Member Functions

 BulkInserterOptions ()
 Creates options with default values.
 
 BulkInserterOptions (int batchSize)
 Creates options with specified batch size.
 
BulkInserterOptions Clone ()
 Creates a copy of these options.
 
 BulkInserterOptions ()
 Creates options with default values.
 
 BulkInserterOptions (int batchSize)
 Creates options with specified batch size.
 
BulkInserterOptions Clone ()
 Creates a copy of these options.
 

​
Properties

int BatchSize = 10_000 [get, set]
 Number of records per batch before triggering a flush.
 
int MaxInFlightBatches = 100 [get, set]
 Maximum number of batches that can be in-flight at once.
 
int NumStripes = Environment.ProcessorCount [get, set]
 Number of stripes per worker queue to reduce lock contention.
 
int MaxFlushWorkers = Math.Max(4, Environment.ProcessorCount * 2) [get, set]
 Maximum number of concurrent flush workers.
 
int MaxRetries = 3 [get, set]
 Maximum number of retry attempts for failed inserts.
 
int FlushIntervalSeconds = 0 [get, set]
 Interval in seconds between automatic flushes.
 
Dictionary< string, string > InsertOptions = new() [get, set]
 Options to pass to the insert_records API.
 
IBatchInsertionListener? BatchListener [get, set]
 Optional batch insertion listener for callbacks on batch completion.
 
Utils.? WorkerList WorkerList [get, set]
 Optional worker list override.
 
int MaxErrorQueueSize = 10_000 [get, set]
 Maximum number of errors to queue before discarding.
 
int CloseTimeoutMs = 60_000 [get, set]
 Timeout for close operations in milliseconds.
 

​
Detailed Description

Configuration options for the BulkInserter<T>.

Definition at line 6 of file BulkInserterOptions.cs.

​
Constructor & Destructor Documentation

​
◆ BulkInserterOptions() [1/4]

kinetica.BulkInserterOptions.BulkInserterOptions ()
 inline

Creates options with default values.

Definition at line 77 of file BulkInserterOptions.cs.

​
◆ BulkInserterOptions() [2/4]

kinetica.BulkInserterOptions.BulkInserterOptions (intbatchSize)
 inline

Creates options with specified batch size.

Definition at line 82 of file BulkInserterOptions.cs.

​
◆ BulkInserterOptions() [3/4]

kinetica.BulkInserterOptions.BulkInserterOptions ()
 inline

Creates options with default values.

Definition at line 77 of file BulkInserterOptions.cs.

​
◆ BulkInserterOptions() [4/4]

kinetica.BulkInserterOptions.BulkInserterOptions (intbatchSize)
 inline

Creates options with specified batch size.

Definition at line 82 of file BulkInserterOptions.cs.

​
Member Function Documentation

​
◆ Clone() [1/2]

BulkInserterOptions kinetica.BulkInserterOptions.Clone ()
 inline

Creates a copy of these options.

Definition at line 90 of file BulkInserterOptions.cs.

​
◆ Clone() [2/2]

BulkInserterOptions kinetica.BulkInserterOptions.Clone ()
 inline

Creates a copy of these options.

Definition at line 90 of file BulkInserterOptions.cs.

​
Property Documentation

​
◆ BatchListener

IBatchInsertionListener kinetica.BulkInserterOptions.BatchListener
 getset

Optional batch insertion listener for callbacks on batch completion.

Definition at line 55 of file BulkInserterOptions.cs.

​
◆ BatchSize

int kinetica.BulkInserterOptions.BatchSize = 10_000
 getset

Number of records per batch before triggering a flush.

Default: 10,000. Recommended range: 5,000 - 50,000.

Definition at line 12 of file BulkInserterOptions.cs.

​
◆ CloseTimeoutMs

int kinetica.BulkInserterOptions.CloseTimeoutMs = 60_000
 getset

Timeout for close operations in milliseconds.

Default: 60,000 (60 seconds).

Definition at line 72 of file BulkInserterOptions.cs.

​
◆ FlushIntervalSeconds

int kinetica.BulkInserterOptions.FlushIntervalSeconds = 0
 getset

Interval in seconds between automatic flushes.

Set to 0 to disable timed flushing. Default: 0 (disabled).

Definition at line 44 of file BulkInserterOptions.cs.

​
◆ InsertOptions

Dictionary< string, string > kinetica.BulkInserterOptions.InsertOptions = new()
 getset

Options to pass to the insert_records API.

Common options: UPDATE_ON_EXISTING_PK, IGNORE_EXISTING_PK, etc.

Definition at line 50 of file BulkInserterOptions.cs.

​
◆ MaxErrorQueueSize

int kinetica.BulkInserterOptions.MaxErrorQueueSize = 10_000
 getset

Maximum number of errors to queue before discarding.

Default: 10,000.

Definition at line 66 of file BulkInserterOptions.cs.

​
◆ MaxFlushWorkers

int kinetica.BulkInserterOptions.MaxFlushWorkers = Math.Max(4, Environment.ProcessorCount * 2)
 getset

Maximum number of concurrent flush workers.

Default: Environment.ProcessorCount * 2.

Definition at line 31 of file BulkInserterOptions.cs.

​
◆ MaxInFlightBatches

int kinetica.BulkInserterOptions.MaxInFlightBatches = 100
 getset

Maximum number of batches that can be in-flight at once.

Used for backpressure control. Default: 100.

Definition at line 19 of file BulkInserterOptions.cs.

​
◆ MaxRetries

int kinetica.BulkInserterOptions.MaxRetries = 3
 getset

Maximum number of retry attempts for failed inserts.

Default: 3.

Definition at line 37 of file BulkInserterOptions.cs.

​
◆ NumStripes

int kinetica.BulkInserterOptions.NumStripes = Environment.ProcessorCount
 getset

Number of stripes per worker queue to reduce lock contention.

Default: Environment.ProcessorCount (number of CPU cores).

Definition at line 25 of file BulkInserterOptions.cs.

​
◆ WorkerList

Utils WorkerList kinetica.BulkInserterOptions.WorkerList
 getset

Optional worker list override.

If null, workers are auto-discovered.

Definition at line 60 of file BulkInserterOptions.cs.

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