Class WriteOptions

WriteOptions are used to configure writes the data point into InfluxDB 2.x.

The default setting use the batching configured to (consistent with Telegraf):

Inheritance
System.Object
WriteOptions
Namespace: InfluxDB.Client
Assembly: InfluxDB.Client.dll
Syntax
public class WriteOptions : object

Constructors

WriteOptions()

Create an instance of WriteOptions.

WriteOptions properties and their default values:

Declaration
public WriteOptions()

Properties

BatchSize

The number of data point to collect in batch.

Declaration
public int BatchSize { get; set; }
Property Value
Type Description
System.Int32
See Also

ExponentialBase

The base for the exponential retry delay.

Declaration
public int ExponentialBase { get; set; }
Property Value
Type Description
System.Int32
See Also

FlushInterval

The time to wait at most (milliseconds).

Declaration
public int FlushInterval { get; set; }
Property Value
Type Description
System.Int32
See Also

JitterInterval

The batch flush jitter interval value (milliseconds).

Declaration
public int JitterInterval { get; set; }
Property Value
Type Description
System.Int32
See Also

MaxRetries

The number of max retries when write fails.

Declaration
public int MaxRetries { get; set; }
Property Value
Type Description
System.Int32
See Also

MaxRetryDelay

The maximum delay between each retry attempt in milliseconds.

Declaration
public int MaxRetryDelay { get; set; }
Property Value
Type Description
System.Int32
See Also

RetryInterval

The time to wait before retry unsuccessful write (milliseconds).

The retry interval is used when the InfluxDB server does not specify "Retry-After" header.

Retry-After: A non-negative decimal integer indicating the seconds to delay after the response is received.

Declaration
public int RetryInterval { get; set; }
Property Value
Type Description
System.Int32
See Also

WriteScheduler

Set the scheduler which is used for write data points.

Declaration
public IScheduler WriteScheduler { get; set; }
Property Value
Type Description
IScheduler
See Also

Methods

CreateNew()

Create a WriteOptions builder.

Declaration
public static WriteOptions.Builder CreateNew()
Returns
Type Description
WriteOptions.Builder

builder