InfluxDB PHP Client
Public Member Functions | Public Attributes | List of all members
InfluxDB2\WriteOptions Class Reference

Public Member Functions

 __construct (array $writeOptions=null)
 

Public Attributes

const DEFAULT_BATCH_SIZE = 10
 
const DEFAULT_RETRY_INTERVAL = 5000
 
const DEFAULT_MAX_RETRIES = 5
 
const DEFAULT_MAX_RETRY_DELAY = 125000
 
const DEFAULT_MAX_RETRY_TIME = 180000
 
const DEFAULT_EXPONENTIAL_BASE = 2
 
const DEFAULT_JITTER_INTERVAL = 0
 
 $writeType
 
 $batchSize
 
 $retryInterval
 
 $maxRetries
 
 $maxRetryDelay
 
 $exponentialBase
 
 $jitterInterval
 
 $maxRetryTime
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\WriteOptions::__construct ( array  $writeOptions = null)

WriteOptions constructor. $writeOptions = [ 'writeType' => methods of write (WriteType::SYNCHRONOUS - default, WriteType::BATCHING) 'batchSize' => the number of data point to collect in batch 'retryInterval' => number of milliseconds to retry unsuccessful write 'maxRetries' => max number of retries when write fails The retry interval is used when the InfluxDB server does not specify "Retry-After" header. 'maxRetryDelay' => maximum delay when retrying write in milliseconds 'maxRetryTime' => maximum total time when retrying write in milliseconds 'exponentialBase' => the base for the exponential retry delay, the next delay is computed using random exponential backoff as a random value within the interval retryInterval * exponentialBase^(attempts-1) and retryInterval * exponentialBase^(attempts). Example for retryInterval=5000, exponentialBase=2, maxRetryDelay=125000, total=5 Retry delays are random distributed values within the ranges of [5000-10000, 10000-20000, 20000-40000, 40000-80000, 80000-125000] 'jitterInterval' => the number of milliseconds before the data is written increased by a random amount ]

Parameters
array | null$writeOptionsArray containing the write parameters (See above)

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