influxdb-client

What's Changed

• fix: catch CancelledError and TimeoutError and add note about timeout by @karel-rehor in #679

Full Changelog: v1.47.0...v1.48.0

What's Changed

• fix: url attribute type validation by @VitalyChait in #672
• fix: linting at flux_table.py by @youarecode in #677
• fix: async write prec where DEFAULT_PRECISION should not be used by @karel-rehor in #675

New Contributors

• @VitalyChait made their first contribution in #672
• @youarecode made their first contribution in #677

Full Changelog: v1.46.0...v1.47.0

Bug Fixes

1. #667: Missing py.typed in distribution package

Examples:

1. #664: Multiprocessing example uses new source of data
2. #665: Shows how to leverage header fields in errors returned on write.

1.45.0 [2024-08-12]

Bug Fixes

1. #652: Refactor to timezone specific datetime helpers to avoid use deprecated functions
2. #663: Accept HTTP 201 response to write request

Features

1. #657: Prefer datetime.fromisoformat over dateutil.parse in Python 3.11+
2. #658: Add find_buckets_iter function that allow iterate through all pages of buckets.

Bug Fixes

1. #655: Replace deprecated urllib calls HTTPResponse.getheaders() and HTTPResponse.getheader().

Others

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

Bug Fixes

1. #648: Fix DataFrame serialization with NaN values

Features

1. #643: Add a support for Python 3.12

Bug Fixes

1. #636: Handle missing data in data frames
2. #638, #642: Refactor DataFrame operations to avoid chained assignment and resolve FutureWarning in pandas, ensuring compatibility with pandas 3.0.
3. #641: Correctly dispose ThreadPoolScheduler in WriteApi

Documentation

1. #639: Use Markdown for README

Features

1. #625: Make class Point equatable

Bug Fixes

1. #562: Use ThreadPoolScheduler for WriteApi's batch subject instead of TimeoutScheduler to prevent creating unnecessary threads repeatedly
2. #631: Logging HTTP requests without query parameters

Documentation

1. #635: Fix render README.rst at GitHub

Features

1. #616: Add find_tasks_iter function that allow iterate through all pages of tasks.

Bug Fixes

1. #601: Use HTTResponse.headers to clear deprecation warning [urllib3]
2. #610: Use iloc to clear deprecation warning

Documentation

1. #566: Fix Sphinx documentation build and add support .readthedocs.yml V2 configuration file

Breaking Changes

This release disables using of the HTTP proxy environment variables HTTP_PROXY and HTTPS_PROXY for the asynchronous HTTP client. The proxy environment variables must be explicitly enabled in the client's configuration:

from influxdb_client.client.influxdb_client_async import InfluxDBClientAsync

async with InfluxDBClientAsync(url="http://localhost:8086", token="my-token", org="my-org",
                               client_session_kwargs={'trust_env': True}) as client:
    pass

This release introduces a support for new version of InfluxDB API definitions with following breaking changes:

• User, UserResponse, ResourceMember and ResourceOwner classes no longer supports oauth_id field
• Task class no longer supports type field
• ScriptUpdateRequest class no longer supports name field
• UsersService.get_flags operation is moved to ConfigService

Features

1. #586: Add config_name key argument for from_config_file function to allow loading a specific configuration from a config file

API

1. #588: Use the latest InfluxDB API definitions for generated APIs

Bug Fixes

1. #583: Async HTTP client doesn't always use HTTP_PROXY/HTTPS_PROXY environment variables. [async/await]
2. #584: Parsing empty query result value as numpy.NaN
3. #595: The Config-Encoding: identity header will no longer be set by the write_api calls to a remote server

1.36.1 [2023-02-23]

Bug Fixes

1. #559: Exceptions in callbacks can cause deadlocks

1.36.0 [2023-01-26]

Features

1. #536: Query to CSV skip empty lines
2. #538: Configure types of integer fields when initializing Point from dict structure

1.35.0 [2022-12-01]

Features

1. #528: Add BucketSchemasService to manage explicit bucket schemas to enforce column names, tags, fields, and data types for your data

Bug Fixes

1. #526: Creating client instance from static configuration
2. #531: HTTP request return type for Management API [async/await]
3. #534: Use HTTResponse.headers to clear deprecation warning [urllib3]

CI

1. #523: Add Python 3.11 to CI builds

Breaking Changes

1. #509: Rename key_file to cert_key_file inside the central configuration class

Features

1. #510: Allow to use client's optional configs for initialization from file or environment properties
2. #509: MTLS support for the InfluxDB Python client

Bug Fixes

1. #512: Exception propagation for asynchronous QueryApi [async/await]
2. #518: Parsing query response with two-bytes UTF-8 character [async/await]
3. #521: Duplicated debug output

Features

1. #498: Add possibility to update user's password by users_api
2. #502: Add FluxRecord.row with response data stored in array

Bug Fixes

1. #497: Parsing InfluxDB response with new line character in CSV column [async/await]

:warning: This release drop supports for Python 3.6. As of 2021-12-23, 3.6 has reached the end-of-life phase of its release cycle. 3.6.15 was the final security release. For more info see: https://peps.python.org/pep-0494/#lifespan

Bug Fixes

1. #483: Querying data if the debug is enabled
2. #477: Parsing date fails due to thread race
3. #486: Serializing DataFrames with columns starting with digits
4. #491: Creating Tasks with import statements

Dependencies

1. #472: Update RxPY to 4.0.4

Others

1. #472: Drop supports for Python 3.6
2. #495: Add warning for measurement name starts with #

Documentation

1. #397: Add an example: How to use RxPY to prepare batches by maximum bytes count
2. #269: Add new example: How to check connection credentials

Features

1. #467: Add possibility to initialize client by json file
2. #450: Improve Query UX - simplify serialization to JSON and add possibility to serialize query results as a flattened list of values

Bug Fixes

1. #462: Redact the Authorization HTTP header from log

Features

1. #440: Add possibility to specify timestamp column and its timezone [DataFrame]

Bug Fixes

1. #457: Formatting nanoseconds to Flux AST

Bug Fixes

1. #443: Initialization of the client without auth credentials

Breaking Changes

1. #433: Rename InvocableScripts to InvokableScripts

Features

1. #435: Add possibility to authenticate by username/password

Dependencies

1. #439: Remove six library

Documentation

1. #434: How the client uses logging

Features

1. #413: Add support for async/await with asyncio via InfluxDBClientAsync, for more info see: How to use Asyncio

Bug Fixes

1. #425: Improve error message if there is no organization with required name

Features

1. #412: DeleteApi uses default value from InfluxDBClient.org if an org parameter is not specified
2. #405: Add InfluxLoggingHandler. A handler to use the client in native python logging.
3. #404: Add InvocableScriptsApi to create, update, list, delete and invoke scripts by seamless way

Bug Fixes

1. #419: Use allowed_methods to clear deprecation warning [urllib3]

Dependencies

1. #419: Update dependencies:
   • urllib3 to 1.26.0

CI

1. #411: Use new Codecov uploader for reporting code coverage

Breaking Changes

This release introduces a support for new version of InfluxDB OSS API definitions - oss.yml. The following breaking changes are in underlying API services and doesn't affect common apis such as - WriteApi, QueryApi, BucketsApi, OrganizationsApi...

• Add LegacyAuthorizationsService to deal with legacy authorizations
• Add ResourceService to retrieve all knows resources
• Add BackupService to represents the data backup functions of InfluxDB
• Add ReplicationsService to represents the replication functions of InfluxDB
• Add RestoreService to represents the data restore functions of InfluxDB
• Add ConfigService to retrieve InfluxDB's runtime configuration
• Add RemoteConnectionsService to deal with registered remote InfluxDB connections
• Add TelegrafPluginsService to retrieve all Telegraf's plugins
• Update TemplatesService to deal with Stack and Template API
• DBRPsService:
  • doesn't requires org_id parameter for operations
  • get_dbr_ps_id operation uses DBRPGet as a type of result
  • patch_dbrpid operation uses DBRPGet as a type of result
  • post_dbrp operation uses DBRPCreate as a type of request
• DefaultService:
  • get_routes operation is moved to RoutesService
  • get_telegraf_plugin operation is moved to TelegrafsService
  • post_signin operation is moved to SigninService
  • post_signout operation is moved to SignoutService
• OrganizationsService:
  • get_orgs_id_secrets operation is moved to SecretsService
  • patch_orgs_id_secrets operation is moved to SecretsService
  • post_orgs_id_secrets operation is moved to SecretsService
• Remove DocumentApi in favour of InfluxDB Community Templates. For more info see - influxdb#19300, openapi#192
• TelegrafsService uses TelegrafPluginRequest to create Telegraf configuration
• TelegrafsService uses TelegrafPluginRequest to update Telegraf configuration

API

1. #399: Use the latest InfluxDB OSS API definitions to generated APIs

Bug Fixes

1. #408: Improve error message when the client cannot find organization by name
2. #407: Use pandas.concat() instead of deprecated DataFrame.append() [DataFrame]

Features

1. #393: Added callback function for getting profilers output with example and test

Bug Fixes

1. #375: Construct InfluxDBError without HTTP response
2. #378: Correct serialization DataFrame with nan values [DataFrame]
3. #384: Timeout can be specified as a float
4. #380: Correct data types for querying [DataFrame]
5. #391: Ping function uses debug for log

Documentation

1. #395: Add an example How to use create a Task by API

CI

1. #370: Add Python 3.10 to CI builds

Features

1. #358: Update management API:
   • BucketsApi - add possibility to: update
   • OrganizationsApi - add possibility to: update
   • UsersApi - add possibility to: update, delete, find
2. #356: Add MultiprocessingWriter to write data in independent OS process

Bug Fixes

1. #359: Correct serialization empty columns into LineProtocol [DataFrame]

Deprecates

• InfluxDBClient.health(): instead use InfluxDBClient.ping()

Features

1. #352: Add PingService to check status of OSS and Cloud instance

Documentation

1. #344: Add an example How to use Invocable scripts Cloud API

Features

1. #330: Add support for write structured data - NamedTuple, Data Classes
2. #335: Add support for custom precision for index specified as number [DataFrame]
3. #341: Add support for handling batch events

Bug Fixes

1. #348: Optimize appending new columns to Pandas DataFrame [DataFrame]

Documentation

1. #331: Add Migration Guide
2. #341: How to handle client errors

Features

1. #319: Add supports for array expressions in query parameters
2. #320: Add JSONEncoder to encode query results to JSON
3. #317: delete_api also accept datetime as a value for start and stop

Bug Fixes

1. #321: Fixes return type for dashboard when include=properties is used

CI

1. #327: Switch to next-gen CircleCI's convenience images

Features

1. #281: FluxTable, FluxColumn and FluxRecord objects have helpful reprs
2. #293: dataframe_serializer supports batching
3. #301: Add proxy_headers to configuration options
4. #306: Supports numpy type in serialization to Line protocol

Documentation

1. #301: How to configure proxy

Bug Fixes

1. #283: Set proxy server in config file
2. #290: Threshold domain models mapping
3. #290: DashboardService responses types
4. #303: Backslash escaping in serialization to Line protocol
5. #312: Zip structure for AWS Lambda

CI

1. #299: Deploy package to Anaconda.org

Features

1. #264: Org parameter can be specified as ID, Name or Organization Object [write, query]

Deprecated

1. #264: Deprecated org_id options BucketsApi.create_bucket in favor of org parameter

Bug Fixes

1. #270: Supports write_precision for write Pandas DataFrame

Breaking Changes

This release introduces a support for new InfluxDB OSS API definitions - oss.yml. The following breaking changes are in underlying API services and doesn't affect common apis such as - WriteApi, QueryApi, BucketsApi, OrganizationsApi...

• AuthorizationsService uses AuthorizationPostRequest to create Authorization
• BucketsService uses PatchBucketRequest to update Bucket
• DashboardsService uses PatchDashboardRequest to update Dashboard
• DeleteService is used to delete tome series date instead of DefaultService
• DBRPs contains list of DBRP in content property
• OrganizationsService uses PostOrganizationRequest to create Organization
• Run contains list of LogEvent in log property
• OrganizationsService uses PatchOrganizationRequest to update Organization
• OnboardingResponse uses UserResponse as user property
• ResourceMember and ResourceOwner inherits from UserResponse
• Users contains list of UserResponse in users property
• UsersService uses UserResponse as a response to requests

Features

1. #237: Use kwargs to pass query parameters into API list call - useful for the ability to use pagination.
2. #241: Add detail error message for not supported type of Point.field
3. #238: Add possibility to specify default timezone for datetimes without tzinfo
4. #262: Add option auth_basic to allow proxied access to InfluxDB 1.8.x compatibility API

Bug Fixes

1. #254: Serialize numpy floats into LineProtocol

Documentation

1. #255: Fix invalid description for env var INFLUXDB_V2_CONNECTION_POOL_MAXSIZE

API

1. #261: Use InfluxDB OSS API definitions to generated APIs

Features

1. #203: Bind query parameters
2. #225: Exponential random backoff retry strategy

Bug Fixes

1. #222: Pass configured timeout to HTTP client
2. #218: Support for with .. as .. statement
3. #232: Specify package requirements in setup.py
4. #235: Write a dictionary-style object without tags

Features

1. #203: Configure a client via TOML file
2. #215: Configure a connection pool maxsize

Bug Fixes

1. #206: Use default (system) certificates instead of Mozilla's root certificates (certifi.where())
2. #217: Fixed clone_task function

API

1. #209: Allow setting shard-group durations for buckets via API

Documentation

1. #202: Added an example how to use RxPY and sync batching
2. #213: Added an example how to use Buckets API

Bug Fixes

1. #193: Fixed tasks_api to use proper function to get Run

Documentation

1. #200: Updated docs, examples, tests: use close instead of __del__.

CI

1. #199: Updated stable image to influxdb:latest and nightly to quay.io/influxdb/influxdb:nightly

Features

1. #176: Allow providing proxy option to InfluxDBClient

Bug Fixes

1. #183: Fixes to DataFrame writing.
2. #181: Encode Point whole numbers without trailing .0

Documentation

1. #189: Updated docs about DeleteApi.

CI

1. #179: Updated default docker image to v2.0.3

Features

1. #171: CSV parser is able to parse export from UI

Bug Fixes

1. #170: Skip DataFrame rows without data - all fields are nan.

CI

1. #175: Updated default docker image to v2.0.2

1. #163: Added support for Python 3.9

Features

1. #161: Added logging message for retries

Bug Fixes

1. #164: Excluded tests from packaging

Features

1. #152: WriteApi supports generic Iterable type
2. #158: Added possibility to specify certificate file path to verify the peer

API

1. #151: Default port changed from 9999 -> 8086
2. #156: Removed labels in organization API, removed Pkg* structure and package service

Bug Fixes

1. #154: Fixed escaping string fields in DataFrame serialization

Features

1. #140: Added exponential backoff strategy for batching writes, Allowed to configure default retry strategy. Default value for retry_interval is 5_000 milliseconds.
2. #136: Allows users to skip of verifying SSL certificate
3. #143: Skip of verifying SSL certificate could be configured via config file or environment properties
4. #141: Added possibility to use datetime nanoseconds precision by pandas.Timestamp
5. #145: Api generator was moved to influxdb-clients-apigen

Features

1. #112: Support timestamp with different timezone in _convert_timestamp
2. #120: ciso8601 is an optional dependency and has to be installed separably
3. #121: Added query_data_frame_stream method
4. #132: Use microseconds resolutions for data points

Bug Fixes

1. #117: Fixed appending default tags for single Point
2. #115: Fixed serialization of \n, \r and \t to Line Protocol, = is valid sign for measurement name
3. #118: Fixed serialization of DataFrame with empty (NaN) values
4. #130: Use Retry-After header value for Retryable error codes

Features

1. #92: Optimize serializing Pandas DataFrame for writing

API

1. #110: Removed log system from Bucket, Dashboard, Organization, Task and Users API - influxdb#18459, Update swagger to latest version

Bug Fixes

1. #105: Fixed mapping dictionary without timestamp and tags into LineProtocol
2. #108: The WriteApi uses precision from Point instead a default precision

Features

1. #79: Added support for writing Pandas DataFrame

Bug Fixes

1. #85: Fixed a possibility to generate empty write batch
2. #86: BREAKING CHANGE: Fixed parameters in delete api - now delete api accepts also bucket name and org name instead of only ids
3. #93: Remove trailing slash from connection URL

Documentation

1. #75: Updated docs to clarify how to use an org parameter
2. #84: Clarify how to use a client with InfluxDB 1.8

Bug Fixes

1. #72: Optimize serializing data into Pandas DataFrame

Features

1. #59: Set User-Agent to influxdb-client-python/VERSION for all requests

Bugs

1. #61: Correctly parse CSV where multiple results include multiple tables
2. #66: Correctly close connection pool manager at exit
3. #69: InfluxDBClient and WriteApi could serialized by pickle (python3.7 or higher)

Features

1. #52: Initialize client library from config file and environmental properties

CI

1. #54: Add Python 3.7 and 3.8 to CI builds

Bugs

1. #56: Fix default tags for write batching, added new test
2. #58: Source distribution also contains: requirements.txt, extra-requirements.txt and test-requirements.txt

Features

1. #50: Implemented default tags

API

1. #47: Updated swagger to latest version

CI

1. #49: Added beta release to continuous integration

Bugs

1. #48: InfluxDBClient default org is used by WriteAPI

1.2.0 [2019-12-06]

Features

1. #44: Optimized serialization into LineProtocol, Clarified how to use client for import large amount of data

API

1. #42: Updated swagger to latest version

Bugs

1. #45: Pandas is a optional dependency and has to installed separably

Features

1. #29: Added support for serialise response into Pandas DataFrame

1.0.0 [2019-11-11]

Features

1. #24: Added possibility to write dictionary-style object
2. #27: Added possibility to write bytes type of data
3. #30: Added support for streaming a query response
4. #35: FluxRecord supports dictionary-style access
5. #31: Added support for delete metrics

API

1. #28: Updated swagger to latest version

Bugs

1. #19: Removed strict checking of enum values

Documentation

1. #22: Documented how to connect to InfluxCloud

Features

1. #2: The write client is able to write data in batches (configuration: batch_size, flush_interval, jitter_interval, retry_interval)
2. #5: Added support for gzip compression of query response and write body

API

1. #10: Updated swagger to latest version

Bug Fixes

1. #3: The management API correctly supports inheritance defined in Influx API
2. #7: Drop NaN and infinity values from fields when writing to InfluxDB

CI

1. #11: Switch CI to CircleCI
2. #12: CI generate code coverage report on CircleCI