Skip to content

fix: docs about using of write_api batching mode #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2021
Merged

fix: docs about using of write_api batching mode #334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee569c0
fix: docs about using of `write_api` batching mode
bednar Sep 30, 2021
9ac3dcf
fix: docs about using of `write_api` batching mode
bednar Sep 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,11 @@ Writes
The `WriteApi <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/write_api.py>`_ supports synchronous, asynchronous and batching writes into InfluxDB 2.0.
The data should be passed as a `InfluxDB Line Protocol <https://docs.influxdata.com/influxdb/latest/write_protocols/line_protocol_tutorial/>`_\ , `Data Point <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/write/point.py>`_ or Observable stream.

**Important: The WriteApi in batching mode (default mode) is suppose to run as a singleton. To flush all your data you should wrap the execution using ``with client.write_api(...) as write_api:`` statement or call ``_write_client.close()`` at the end of your script.**
.. warning::

The ``WriteApi`` in batching mode (default mode) is suppose to run as a singleton.
To flush all your data you should wrap the execution using ``with client.write_api(...) as write_api:`` statement
or call ``write_api.close()`` at the end of your script.

*The default instance of WriteApi use batching.*

Expand Down