influxdb3-python 0.12.0__tar.gz → 0.13.0__tar.gz

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/basic_ssl_example.py

@@ -70,7 +70,6 @@ def write_and_query_with_explicit_sys_cert(conf):
     print("\nwrite and query with typical linux system cert\n")
     with InfluxDBClient3(token=conf.token,
                          host=conf.host,
-                         org=conf.org,
                          database=conf.database,
                          ssl_ca_cert="/etc/ssl/certs/ca-certificates.crt",
                          verify_ssl=True) as _client:
@@ -90,7 +89,6 @@ def query_with_verify_ssl_off(conf, cert):
     # Switch verify_ssl to True to throw SSL_ERROR_SSL
     with InfluxDBClient3(token=conf.token,
                          host=conf.host,
-                         org=conf.org,
                          database=conf.database,
                          ssl_ca_cert=cert,
                          verify_ssl=False) as _client:

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/batching_example.py

@@ -70,7 +70,6 @@ def main() -> None:
     # of 10k ms and gzip compression
     with InfluxDBClient3.InfluxDBClient3(token=conf.token,
                                          host=conf.host,
-                                         org=conf.org,
                                          database=conf.database,
                                          enable_gzip=True,
                                          write_client_options=wco) as _client:

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/cloud_dedicated_query.py

@@ -6,7 +6,6 @@ config = Config()
 client = InfluxDBClient3.InfluxDBClient3(
     token=config.token,
     host=config.host,
-    org=config.org,
     database=config.database)
 
 table = client.query(

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/cloud_dedicated_write.py

@@ -9,7 +9,6 @@ config = Config()
 client = InfluxDBClient3.InfluxDBClient3(
     token=config.token,
     host=config.host,
-    org=config.org,
     database=config.database,
     write_options=WriteOptions(
         batch_size=500,

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/config.py

@@ -6,7 +6,6 @@ class Config:
     def __init__(self):
         self.host = os.getenv('INFLUXDB_HOST') or 'https://us-east-1-1.aws.cloud2.influxdata.com/'
         self.token = os.getenv('INFLUXDB_TOKEN') or 'my-token'
-        self.org = os.getenv('INFLUXDB_ORG') or 'my-org'
         self.database = os.getenv('INFLUXDB_DATABASE') or 'my-db'
 
     def __str__(self):

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/flight_options_example.py

@@ -10,7 +10,6 @@ print(cert)
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="b0c7cce5-8dbc-428e-98c6-7f996fb96467.a.influxdb.io",
-    org="6a841c0c08328fb1",
     database="flightdemo",
     flight_client_options=flight_client_options(
         tls_root_certs=cert))

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/handle_http_error.py

@@ -18,7 +18,6 @@ def main() -> None:
     client = InfluxDBClient3.InfluxDBClient3(
         host=config.host,
         token=config.token,
-        org=config.org,
         database=config.database
     )
 

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/pandas_write.py

@@ -5,7 +5,6 @@ import numpy as np
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="eu-central-1-1.aws.cloud2.influxdata.com",
-    org="",
     database="")
 
 

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/query_async.py

@@ -72,7 +72,6 @@ async def main():
         host=config.host,
         token=config.token,
         database=config.database,
-        org=config.org
     )
     measurement = 'example_uav'
     write_data(client, measurement)

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/Examples/query_type.py

@@ -3,7 +3,6 @@ import influxdb_client_3 as InfluxDBClient3
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="eu-central-1-1.aws.cloud2.influxdata.com",
-    org="6a841c0c08328fb1",
     database="factory")
 
 

{influxdb3_python-0.12.0/influxdb3_python.egg-info → influxdb3_python-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: influxdb3-python
-Version: 0.12.0
+Version: 0.13.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -104,13 +104,11 @@ from influxdb_client_3 import InfluxDBClient3, Point
 
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
-1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use bucket name for the `database` argument.
+1. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",
                          host="your-host",
-                         org="your-org",
                          database="your-database")
 ```
 
@@ -171,7 +169,6 @@ wco = write_client_options(success_callback=callback.success,
 with  InfluxDBClient3.InfluxDBClient3(
     token="INSERT_TOKEN",
     host="eu-central-1-1.aws.cloud2.influxdata.com",
-    org="6a841c0c08328fb1",
     database="python", write_client_options=wco) as client:
 
 
@@ -218,27 +215,24 @@ Install `certifi`
 pip install certifi
 ```
 Next include certifi within the flight client options:
+
 ```python
+import certifi
+
 import influxdb_client_3 as InfluxDBClient3
-import pandas as pd
-import numpy as np
 from influxdb_client_3 import flight_client_options
-import certifi
 
 fh = open(certifi.where(), "r")
 cert = fh.read()
 fh.close()
 
-
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="b0c7cce5-8dbc-428e-98c6-7f996fb96467.a.influxdb.io",
-    org="6a841c0c08328fb1",
     database="flightdemo",
     flight_client_options=flight_client_options(
         tls_root_certs=cert))
 
-
 table = client.query(
     query="SELECT * FROM flight WHERE time > now() - 4h",
     language="influxql")

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/README.md

@@ -57,13 +57,11 @@ from influxdb_client_3 import InfluxDBClient3, Point
 
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
-1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use bucket name for the `database` argument.
+1. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",
                          host="your-host",
-                         org="your-org",
                          database="your-database")
 ```
 
@@ -124,7 +122,6 @@ wco = write_client_options(success_callback=callback.success,
 with  InfluxDBClient3.InfluxDBClient3(
     token="INSERT_TOKEN",
     host="eu-central-1-1.aws.cloud2.influxdata.com",
-    org="6a841c0c08328fb1",
     database="python", write_client_options=wco) as client:
 
 
@@ -171,27 +168,24 @@ Install `certifi`
 pip install certifi
 ```
 Next include certifi within the flight client options:
+
 ```python
+import certifi
+
 import influxdb_client_3 as InfluxDBClient3
-import pandas as pd
-import numpy as np
 from influxdb_client_3 import flight_client_options
-import certifi
 
 fh = open(certifi.where(), "r")
 cert = fh.read()
 fh.close()
 
-
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="b0c7cce5-8dbc-428e-98c6-7f996fb96467.a.influxdb.io",
-    org="6a841c0c08328fb1",
     database="flightdemo",
     flight_client_options=flight_client_options(
         tls_root_certs=cert))
 
-
 table = client.query(
     query="SELECT * FROM flight WHERE time > now() - 4h",
     language="influxql")

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0/influxdb3_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: influxdb3-python
-Version: 0.12.0
+Version: 0.13.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -104,13 +104,11 @@ from influxdb_client_3 import InfluxDBClient3, Point
 
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
-1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use bucket name for the `database` argument.
+1. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",
                          host="your-host",
-                         org="your-org",
                          database="your-database")
 ```
 
@@ -171,7 +169,6 @@ wco = write_client_options(success_callback=callback.success,
 with  InfluxDBClient3.InfluxDBClient3(
     token="INSERT_TOKEN",
     host="eu-central-1-1.aws.cloud2.influxdata.com",
-    org="6a841c0c08328fb1",
     database="python", write_client_options=wco) as client:
 
 
@@ -218,27 +215,24 @@ Install `certifi`
 pip install certifi
 ```
 Next include certifi within the flight client options:
+
 ```python
+import certifi
+
 import influxdb_client_3 as InfluxDBClient3
-import pandas as pd
-import numpy as np
 from influxdb_client_3 import flight_client_options
-import certifi
 
 fh = open(certifi.where(), "r")
 cert = fh.read()
 fh.close()
 
-
 client = InfluxDBClient3.InfluxDBClient3(
     token="",
     host="b0c7cce5-8dbc-428e-98c6-7f996fb96467.a.influxdb.io",
-    org="6a841c0c08328fb1",
     database="flightdemo",
     flight_client_options=flight_client_options(
         tls_root_certs=cert))
 
-
 table = client.query(
     query="SELECT * FROM flight WHERE time > now() - 4h",
     language="influxql")

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/__init__.py

@@ -1,17 +1,28 @@
+import importlib.util
+import os
 import urllib.parse
+from typing import Any
+
 import pyarrow as pa
-import importlib.util
 
 from influxdb_client_3.query.query_api import QueryApi as _QueryApi, QueryApiOptionsBuilder
 from influxdb_client_3.read_file import UploadFile
 from influxdb_client_3.write_client import InfluxDBClient as _InfluxDBClient, WriteOptions, Point
 from influxdb_client_3.write_client.client.exceptions import InfluxDBError
 from influxdb_client_3.write_client.client.write_api import WriteApi as _WriteApi, SYNCHRONOUS, ASYNCHRONOUS, \
-    PointSettings
+    PointSettings, DefaultWriteOptions, WriteType
 from influxdb_client_3.write_client.domain.write_precision import WritePrecision
 
 polars = importlib.util.find_spec("polars") is not None
 
+INFLUX_HOST = "INFLUX_HOST"
+INFLUX_TOKEN = "INFLUX_TOKEN"
+INFLUX_DATABASE = "INFLUX_DATABASE"
+INFLUX_ORG = "INFLUX_ORG"
+INFLUX_PRECISION = "INFLUX_PRECISION"
+INFLUX_AUTH_SCHEME = "INFLUX_AUTH_SCHEME"
+INFLUX_GZIP_THRESHOLD = "INFLUX_GZIP_THRESHOLD"
+
 
 def write_client_options(**kwargs):
     """
@@ -83,6 +94,51 @@ def _merge_options(defaults, exclude_keys=None, custom=None):
     return _deep_merge(defaults, {key: value for key, value in custom.items() if key not in exclude_keys})
 
 
+def _parse_precision(precision):
+    """
+    Parses the precision value and ensures it is valid.
+
+    This function checks that the given `precision` is one of the allowed
+    values defined in `WritePrecision`. If the precision is invalid, it
+    raises a `ValueError`. The function returns the valid precision value
+    if it passes validation.
+
+    :param precision: The precision value to be validated.
+                      Must be one of WritePrecision.NS, WritePrecision.MS,
+                      WritePrecision.S, or WritePrecision.US.
+    :return: The valid precision value.
+    :rtype: WritePrecision
+    :raises ValueError: If the provided precision is not valid.
+    """
+    if precision not in [WritePrecision.NS, WritePrecision.MS, WritePrecision.S, WritePrecision.US]:
+        raise ValueError(f"Invalid precision value: {precision}")
+    return precision
+
+
+def _parse_gzip_threshold(threshold):
+    """
+    Parses and validates the provided threshold value.
+
+    This function ensures that the given threshold is a valid integer value,
+    and it raises an appropriate error if the threshold is not valid. It also
+    enforces that the threshold value is non-negative.
+
+    :param threshold: The input threshold value to be parsed and validated.
+    :type threshold: Any
+    :return: The validated threshold value as an integer.
+    :rtype: int
+    :raises ValueError: If the provided threshold is not an integer or if it is
+        negative.
+    """
+    try:
+        threshold = int(threshold)
+    except (TypeError, ValueError):
+        raise ValueError(f"Invalid threshold value: {threshold}. Must be integer.")
+    if threshold < 0:
+        raise ValueError(f"Invalid threshold value: {threshold}. Must be non-negative.")
+    return threshold
+
+
 class InfluxDBClient3:
     def __init__(
             self,
@@ -136,8 +192,23 @@ class InfluxDBClient3:
         self._org = org if org is not None else "default"
         self._database = database
         self._token = token
-        self._write_client_options = write_client_options if write_client_options is not None \
-            else default_client_options(write_options=SYNCHRONOUS)
+
+        write_type = DefaultWriteOptions.write_type.value
+        write_precision = DefaultWriteOptions.write_precision.value
+        if isinstance(write_client_options, dict) and write_client_options.get('write_options') is not None:
+            write_opts = write_client_options['write_options']
+            write_type = getattr(write_opts, 'write_type', write_type)
+            write_precision = getattr(write_opts, 'write_precision', write_precision)
+
+        write_options = WriteOptions(
+            write_type=write_type,
+            write_precision=write_precision,
+        )
+
+        self._write_client_options = {
+            "write_options": write_options,
+            **(write_client_options or {})
+        }
 
         # Parse the host input
         parsed_url = urllib.parse.urlparse(host)
@@ -178,6 +249,60 @@ class InfluxDBClient3:
                                     flight_client_options=flight_client_options,
                                     proxy=kwargs.get("proxy", None), options=q_opts_builder.build())
 
+    @classmethod
+    def from_env(cls, **kwargs: Any) -> 'InfluxDBClient3':
+        """
+        Creates an instance of the ``InfluxDBClient3`` class using environment
+        variables for configuration. This method simplifies client creation by
+        automatically reading required information from the system environment.
+
+        It verifies the presence of required environment variables such as host,
+        token, and database. If any of these variables are missing or empty,
+        a ``ValueError`` will be raised. Optional parameters such as precision and
+        authentication scheme will also be extracted from the environment when
+        present, allowing further customization of the client.
+
+        :param kwargs: Additional parameters that are passed to the client constructor.
+        :type kwargs: Any
+        :raises ValueError: If any required environment variables are missing or empty.
+        :return: An initialized client object of type ``InfluxDBClient3``.
+        :rtype: InfluxDBClient3
+        """
+        required_vars = {
+            INFLUX_HOST: os.getenv(INFLUX_HOST),
+            INFLUX_TOKEN: os.getenv(INFLUX_TOKEN),
+            INFLUX_DATABASE: os.getenv(INFLUX_DATABASE)
+        }
+        missing_vars = [var for var, value in required_vars.items() if value is None or value == ""]
+        if missing_vars:
+            raise ValueError(f"Missing required environment variables: {', '.join(missing_vars)}")
+
+        write_options = WriteOptions(write_type=WriteType.synchronous)
+
+        gzip_threshold = os.getenv(INFLUX_GZIP_THRESHOLD)
+        if gzip_threshold is not None:
+            kwargs['gzip_threshold'] = _parse_gzip_threshold(gzip_threshold)
+            kwargs['enable_gzip'] = True
+
+        precision = os.getenv(INFLUX_PRECISION)
+        if precision is not None:
+            write_options.write_precision = _parse_precision(precision)
+
+        write_client_option = {'write_options': write_options}
+
+        if os.getenv(INFLUX_AUTH_SCHEME) is not None:
+            kwargs['auth_scheme'] = os.getenv(INFLUX_AUTH_SCHEME)
+
+        org = os.getenv(INFLUX_ORG, "default")
+        return InfluxDBClient3(
+            host=required_vars[INFLUX_HOST],
+            token=required_vars[INFLUX_TOKEN],
+            database=required_vars[INFLUX_DATABASE],
+            write_client_options=write_client_option,
+            org=org,
+            **kwargs
+        )
+
     def write(self, record=None, database=None, **kwargs):
         """
         Write data to InfluxDB.

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/query/query_api.py

@@ -104,7 +104,7 @@ class QueryApi(object):
 
 
             # Initialize instance of QueryApi
-            with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
+            with InfluxDBClient(url="http://localhost:8086", token="my-token") as client:
                 query_api = client.query_api()
     """
 

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/version.py

@@ -1,4 +1,4 @@
 """Version of the Client that is used in User-Agent header."""
 
-VERSION = '0.12.0'
+VERSION = '0.13.0'
 USER_AGENT = f'influxdb3-python/{VERSION}'

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/write_client/__init__.py

@@ -2,16 +2,6 @@
 
 # flake8: noqa
 
-"""
-InfluxDB OSS API Service.
-
-The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501
-
-OpenAPI spec version: 2.0.0
-Generated by: https://openapi-generator.tech
-"""
-
-
 from __future__ import absolute_import
 
 from influxdb_client_3.write_client.client.write_api import WriteApi, WriteOptions

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/write_client/_sync/api_client.py

@@ -1,12 +1,4 @@
 # coding: utf-8
-"""
-InfluxDB OSS API Service.
-
-The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501
-
-OpenAPI spec version: 2.0.0
-Generated by: https://openapi-generator.tech
-"""
 
 from __future__ import absolute_import
 
@@ -28,17 +20,7 @@ from influxdb_client_3.write_client.rest import _requires_create_user_session, _
 
 
 class ApiClient(object):
-    """Generic API client for OpenAPI client library Build.
-
-    OpenAPI generic API client. This client handles the client-
-    server communication, and is invariant across implementations. Specifics of
-    the methods and models for each application are generated from the OpenAPI
-    templates.
-
-    NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
-
+    """
     :param configuration: .Configuration object for this client
     :param header_name: a header to pass when making calls to the API.
     :param header_value: a header value to pass when making calls to
@@ -110,6 +92,40 @@ class ApiClient(object):
         """Set HTTP header for this API client."""
         self.default_headers[header_name] = header_value
 
+    @staticmethod
+    def should_gzip(payload: str, enable_gzip: bool = False, gzip_threshold: int = None) -> bool:
+        """
+        Determines whether gzip compression should be applied to the given payload based
+        on the specified conditions. This method evaluates the `enable_gzip` flag and
+        considers the size of the payload in relation to the optional `gzip_threshold`.
+        If `enable_gzip` is set to True and no threshold is provided, gzip compression
+        is advised without any size condition. If a threshold is specified, compression
+        is applied only when the size of the payload meets or exceeds the threshold.
+        By default, no compression is performed if `enable_gzip` is False.
+
+        :param payload: The payload data as a string for which gzip determination is to
+            be made.
+        :type payload: str
+        :param enable_gzip: A flag indicating whether gzip compression is enabled. By
+            default, this flag is False.
+        :type enable_gzip: bool, optional
+        :param gzip_threshold: Optional threshold specifying the minimum size (in bytes)
+            of the payload to trigger gzip compression. Only considered if
+            `enable_gzip` is True.
+        :type gzip_threshold: int, optional
+        :return: A boolean value indicating True if gzip compression should be applied
+            based on the payload size, the enable_gzip flag, and the gzip_threshold.
+        :rtype: bool
+        """
+        if enable_gzip is not False:
+            if gzip_threshold is not None:
+                payload_size = len(payload.encode('utf-8'))
+                return payload_size >= gzip_threshold
+            if enable_gzip is True:
+                return True
+
+        return False
+
     def __call_api(
             self, resource_path, method, path_params=None,
             query_params=None, header_params=None, body=None, post_params=None,
@@ -120,9 +136,16 @@ class ApiClient(object):
         config = self.configuration
         self._signin(resource_path=resource_path)
 
+        # body
+        should_gzip = False
+        if body:
+            should_gzip = self.should_gzip(body, config.enable_gzip, config.gzip_threshold)
+            body = self.sanitize_for_serialization(body)
+            body = config.update_request_body(resource_path, body, should_gzip)
+
         # header parameters
         header_params = header_params or {}
-        config.update_request_header_params(resource_path, header_params)
+        config.update_request_header_params(resource_path, header_params, should_gzip)
         header_params.update(self.default_headers)
         if self.cookie:
             header_params['Cookie'] = self.cookie
@@ -159,11 +182,6 @@ class ApiClient(object):
         # auth setting
         self.update_params_for_auth(header_params, query_params, auth_settings)
 
-        # body
-        if body:
-            body = self.sanitize_for_serialization(body)
-            body = config.update_request_body(resource_path, body)
-
         # request url
         url = self.configuration.host + resource_path
 

{influxdb3_python-0.12.0 → influxdb3_python-0.13.0}/influxdb_client_3/write_client/_sync/rest.py

@@ -1,15 +1,5 @@
 # coding: utf-8
 
-"""
-InfluxDB OSS API Service.
-
-The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501
-
-OpenAPI spec version: 2.0.0
-Generated by: https://openapi-generator.tech
-"""
-
-
 from __future__ import absolute_import
 
 import io
@@ -28,11 +18,6 @@ except ImportError:
 
 
 class RESTResponse(io.IOBase):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
-    """
 
     def __init__(self, resp):
         """Initialize with HTTP response."""
@@ -51,11 +36,6 @@ class RESTResponse(io.IOBase):
 
 
 class RESTClientObject(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
-    """
 
     def __init__(self, configuration, pools_size=4, maxsize=None, retries=False):
         """Initialize REST client."""

{influxdb3_python-0.12.0/influxdb_client_3/write_client/client/write → influxdb3_python-0.13.0/influxdb_client_3/write_client/client}/__init__.py

@@ -1,15 +1,5 @@
 # flake8: noqa
 
-"""
-InfluxDB OSS API Service.
-
-The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501
-
-OpenAPI spec version: 2.0.0
-Generated by: https://openapi-generator.tech
-"""
-
-
 from __future__ import absolute_import
 
 # import apis into api package