Skip to content

Commit 7b786d0

Browse files
committed
docs: update README to include max_close_wait
1 parent 6bdb4c3 commit 7b786d0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,9 @@ The batching is configurable by ``write_options``\ :
447447
* - **max_retry_delay**
448448
- the maximum delay between each retry attempt in milliseconds
449449
- ``125_000``
450+
* - **max_close_wait**
451+
- the maximum amount of time to wait for batches to flush when `.close()` is called
452+
- ``300_000``
450453
* - **exponential_base**
451454
- the base for the exponential retry delay, the next delay is computed using random exponential backoff as a random value within the interval ``retry_interval * exponential_base^(attempts-1)`` and ``retry_interval * exponential_base^(attempts)``. Example for ``retry_interval=5_000, exponential_base=2, max_retry_delay=125_000, total=5`` Retry delays are random distributed values within the ranges of ``[5_000-10_000, 10_000-20_000, 20_000-40_000, 40_000-80_000, 80_000-125_000]``
452455
- ``2``
@@ -470,6 +473,7 @@ The batching is configurable by ``write_options``\ :
470473
retry_interval=5_000,
471474
max_retries=5,
472475
max_retry_delay=30_000,
476+
max_close_wait=300_000,
473477
exponential_base=2)) as _write_client:
474478
475479
"""

0 commit comments

Comments
 (0)