From dc95257c6f1d84cb14c1b120faaef37ef1e0da30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Bedn=C3=A1=C5=99?= Date: Tue, 3 Jan 2023 16:03:55 +0100 Subject: [PATCH] docs: clarify the unit of a parameter (#542) --- README.rst | 2 +- influxdb_client/client/write_api.py | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 08c7f0e9..5e69b75e 100644 --- a/README.rst +++ b/README.rst @@ -427,7 +427,7 @@ The batching is configurable by ``write_options``\ : - Description - Default Value * - **batch_size** - - the number of data pointx to collect in a batch + - the number of data point to collect in a batch - ``1000`` * - **flush_interval** - the number of milliseconds before the batch is written diff --git a/influxdb_client/client/write_api.py b/influxdb_client/client/write_api.py index 64fefb98..f03a3c5f 100644 --- a/influxdb_client/client/write_api.py +++ b/influxdb_client/client/write_api.py @@ -57,10 +57,11 @@ def __init__(self, write_type: WriteType = WriteType.batching, :param write_type: methods of write (batching, asynchronous, synchronous) :param batch_size: the number of data point to collect in batch - :param flush_interval: flush data at least in this interval + :param flush_interval: flush data at least in this interval (milliseconds) :param jitter_interval: this is primarily to avoid large write spikes for users running a large number of - client instances ie, a jitter of 5s and flush duration 10s means flushes will happen every 10-15s. - :param retry_interval: the time to wait before retry unsuccessful write + client instances ie, a jitter of 5s and flush duration 10s means flushes will happen every 10-15s + (milliseconds) + :param retry_interval: the time to wait before retry unsuccessful write (milliseconds) :param max_retries: the number of max retries when write fails, 0 means retry is disabled :param max_retry_delay: the maximum delay between each retry attempt in milliseconds :param max_retry_time: total timeout for all retry attempts in milliseconds, if 0 retry is disabled