influxdb3-python release notes

v0.21.0

Bug Fixes

1. #234: Add support for connecting to InfluxDB servers using IPv6 addresses.
   • IPv6 addresses in server URLs must be enclosed in square brackets, for example, http://[2001:db8::1]:8086.
   • IPv6 zone identifiers are not currently supported.

Breaking Changes

1. #217: Makes the writing API simpler and more consistent with other v3 clients.

   • Removes unused InfluxLoggingHandler class.
   • WriteApi now handles all functions to write to InfluxDB.
     • The following internal classes have been removed:
       • Configuration
       • ApiClient
       • WriteService
       • InfluxDBClient
     • The following internal classes have been refactored:
       • write_client._sync.RestClient - this class is now responsible for low-level handling of transport requests. End users should not need to use it directly.
       • write_client.client.WriteApi - all internal settings needed for writing are now encapsulated within this Api.
   • Refactors Multiprocessing helper class.
   • Migration Guidance
     • InfluxDBClient3 constructor now has additional parameters for configuring the internal WriteApi and RestClient.
       • auth_scheme - string - the token authentation scheme, typically Token or Bearer.
       • enable_gzip - boolean - whether or not to compress data in writing payloads.
       • gzip_threshold - int - minimum payload size to trigger gzip compression when enable_gzip is True.
       • point_settings - PointSettings - default settings used when writing Points, primarily used to wrap default tags to be added to Point data.
       • debug - boolean - toggle debug level logging.
     • Any clients explicitly using the Configuration, ApiClient, WriteService or legacy InfluxDBClient classes, will need to migrate their settings to the InfluxDBClient3 constructor.

2. #222: Refactor MultiprocessingWriter class.

   • New Process will be created by using DefaultContext.Process(target) to prevent erratic crashes, handle cross-platform code behavior safely, and coordinate complex resource sharing.
   • Users can now choose one of the start methods fork, spawn or forkserver when creating new Process. The default will be spawn.
   • Users can set time to live for the child process through process_ttl parameter, the default value will be 300 seconds.

v0.20.0

Features

1. #208: Add influx3 query CLI support for executing SQL/InfluxQL queries with JSON/JSONL/CSV/pretty output, including module execution via python -m influxdb_client_3.
2. #213: Add partial write support and default writes to the V2 API endpoint. See Partial writes for more. no_sync requires use_v2_api=False; accept_partial applies only to V3 API endpoint writes.

Others

1. #215:
   • Remove cookie/session-based signin/signout support from the writing client.
   • Remove basic authentication with a username and password.

v0.19.0

Features

1. #198: Support custom tag order via tag_order write option. See Sort tags by priority for more.
2. #202: Add escape for field keys when serializing to line protocol in PolarsDataframeSerializer.

v0.18.0

Features

1. #196: Support passing middleware functions to the Flight client.

Bug Fixes

1. #194: Fix InfluxDBClient3.write_file() and InfluxDBClient3.write_dataframe() fail with batching mode.
2. #197: InfluxDB 3 Core/Enterprise write errors details handling.

v0.17.0

Features

1. #177: Add dedicated DataFrame methods for improved usability and type safety:
   • write_dataframe(): New method for writing pandas and polars DataFrames with explicit parameters (measurement, timestamp_column, tags, timestamp_timezone).
   • query_dataframe(): New method for querying data directly to a pandas or polars DataFrame via the frame_type parameter.
   • Updated README with clear examples for DataFrame operations.
2. #179: Add option to disable gRPC response compression for Flight queries:
   • disable_grpc_compression parameter in InfluxDBClient3 constructor
   • INFLUX_DISABLE_GRPC_COMPRESSION environment variable support in from_env()
3. #180: Add flush() method to InfluxDBClient3:
   • Allows flushing the write buffer without closing the client when using batching mode.
   • Enables applications to ensure data is written before querying, while keeping the client open for further operations.
4. #185:
   • Add API Reference page on document page
   • Remove old document link.
   • Add link to document page in README.md

Bug Fixes

1. #177: Fix TypeError when writing DataFrames. Serializer-specific kwargs (e.g., data_frame_measurement_name) are now filtered before being passed to the HTTP layer.

• CI updates

v0.16.0

Features

1. #158 Improved parameters for setting timeouts
   • InfluxDB3Client() constructor now directly specifies
     • write_timeout - timeout in milliseconds to be used when writing data.
     • query_timeout - timeout in milliseconds to be used when querying data.
   • Timeouts can be specifically overridden in direct method calls.
     • client.write() now propagates the argument _request_timeout as an int in milliseconds on the call stack even in batching mode.
     • client.query() now propagates the argument timeout as a float in seconds on the call stack.

• CI updates

v0.15.0

Features

1. #146: Add function to get InfluxDB version.
2. #149: Run integration tests against a locally started InfluxDB 3 Core server.

v0.14.0

Features

1. #141 Move “setuptools” package to build dependency.
2. #142: Support fast writes without waiting for WAL persistence:
   • New write option (WriteOptions.no_sync) added: True value means faster write but without the confirmation that the data was persisted. Default value: False.
   • Supported by self-managed InfluxDB 3 Core and Enterprise servers only!
   • Also configurable via environment variable (INFLUX_WRITE_NO_SYNC).
   • Long precision string values added from v3 HTTP API: "nanosecond", "microsecond", "millisecond", "second" ( in addition to the existing "ns", "us", "ms", "s").
3. #145: Improve the document wording for README.md

v0.13.0

Features

1. #130: Remove org parameters from the example code because It is not mandatory in Influxdb3
2. #139: Supports environment variables with the same name as other clients
3. #140: Query api will throw InfluxdbClientQueryError when receiving ArrowException from gRPC servers

v0.12.0

Features

1. #123: Introduces query_async() method. From this release the client now has a query_async() method that takes advantage of asyncio’s event loop to run query calls in their own executor.

For example:

    table = await client.query_async(query)

Bug Fixes

1. #121: Fix use of arguments verify_ssl and ssl_ca_cert in QueryApi.

v0.11.0

Bug Fixes

1. #119: Fix use of proxy argument in client and query_api to use in channel solution for GRPC proxy.

v0.10.0

Bug Fixes

1. #113: Fix import error of PolarsDataframeSerializer in batching mode

v0.9.0

Features

1. #108: Better expose access to response headers in InfluxDBError. Example handle_http_error added.
2. #112: Update batching examples, add integration tests of batching.

Bug Fixes

1. #107: Missing py.typed in distribution package
2. #111: Reduce log level of disposal of batch processor to DEBUG

v0.8.0

Features

1. #101: Add support for InfluxDB Edge (OSS) authentication

Bug Fixes

1. #100: InfluxDB Edge (OSS) error handling
2. #105: Importing Polars serialization module

v0.7.0

Bug Fixes

1. #95: Polars is optional dependency
2. #99: Skip infinite values during serialization to line protocol

v0.6.1

Bug Fixes

1. #98: Missing declaration for query module

v0.6.0

Features

1. #89: Use datetime.fromisoformat over dateutil.parse in Python 3.11+
2. #92: Update user-agent header value to influxdb3-python/{VERSION} and add it to queries as well.

Bug Fixes

1. #86: Refactor to timezone specific datetime helpers to avoid use deprecated functions

v0.5.0

Features

1. #88: Add support for named query parameters:

   from influxdb_client_3 import InfluxDBClient3
   
   with InfluxDBClient3(host="https://us-east-1-1.aws.cloud2.influxdata.com",
                        token="my-token",
                        database="my-database") as client:
   
        table = client.query("select * from cpu where host=$host", query_parameters={"host": "server01"})
   
        print(table.to_pandas())

Bug Fixes

1. #87: Fix examples to use write_options instead of the object name WriteOptions

Others

1. #84: Enable packaging type information - py.typed

v0.4.0

Bugfix

1. #77: Support using pandas nullable types

Others

1. #80: Integrate code style check into CI