influxdb3-python 0.16.0__tar.gz → 0.18.0__tar.gz

influxdb3_python-0.18.0/Examples/query_with_middleware.py

@@ -0,0 +1,33 @@
+from pyarrow import flight
+
+from config import Config
+from influxdb_client_3 import InfluxDBClient3, flight_client_options
+
+
+# This middleware will add an additional attribute `some-attribute` to the header
+class ModifyHeaderClientMiddleware(flight.ClientMiddleware):
+    def sending_headers(self):
+        return {
+            "some-attribute": "some-value",
+        }
+
+    def received_headers(self, headers):
+        pass
+
+
+class ModifyHeaderClientMiddlewareFactory(flight.ClientMiddlewareFactory):
+    def start_call(self, info):
+        return ModifyHeaderClientMiddleware()
+
+
+config = Config()
+middleware = [ModifyHeaderClientMiddlewareFactory()]
+client = InfluxDBClient3(
+    host=config.host,
+    token=config.token,
+    database=config.database,
+    flight_client_options=flight_client_options(middleware=middleware)
+)
+
+df = client.query(query="select * from cpu11 limit 10", mode="pandas")
+print(len(df))

influxdb3_python-0.18.0/Examples/timeouts.py

@@ -0,0 +1,83 @@
+#!/usr/bin/env python3
+import sys
+import time
+
+from influxdb_client_3 import InfluxDBClient3, write_client_options
+
+"""
+This example shows how to set query and write timeouts.
+They can be set directly using arguments (write_timeout, query_timeout) in the client constructor.
+They can also be overridden in write and query calls.
+
+To trigger timeout and deadline expired exceptions, reset the timeout values in the examples or
+supply new values as command line parameters.
+
+Be sure to update the host, token a database values below, before running this example.
+"""
+
+DEFAULT_WRITE_TIMEOUT = 30_000  # in milliseconds
+DEFAULT_QUERY_TIMEOUT = 120_000  # in milliseconds
+DEFAULT_HOST = 'http://localhost:8181'
+DEFAULT_TOKEN = 'my-token'
+DEFAULT_DATABASE = 'test-data'
+
+
+def handle_write_error_cb(rd, rt, rx):
+    print(f"Got a write error: {rd}, {rt}, {rx}")
+
+
+def main(w_to: int, q_to: int) -> None:
+    print(f"main {w_to}, {q_to}")
+    lp_data = "timeout_example,location=terra fVal=3.14,iVal=42i"
+    with InfluxDBClient3(
+        host=DEFAULT_HOST,
+        token=DEFAULT_TOKEN,
+        database=DEFAULT_DATABASE,
+        write_timeout=w_to,
+        query_timeout=q_to,
+        write_client_options=write_client_options(
+            error_handler=handle_write_error_cb
+        )
+    ) as client:
+
+        try:
+            # write with write timeout set in client
+            client.write(record=lp_data)
+            print("First write OK.")
+            time.sleep(1)
+
+            # write overriding client internal write timeout
+            # to force an exception try a _request_timeout value like 1 ms
+            client.write(record=lp_data, _request_timeout=9_000)
+            print("Second write OK.")
+            time.sleep(1)
+        except Exception as e:
+            print(f"Got exception on write: {e}")
+
+        sql = "SELECT * FROM timeout_example"
+
+        try:
+            # query using query timeout set in client
+            result = client.query(sql)
+            print("\nFirst query result\n", result)
+            time.sleep(1)
+
+            # query overriding client internal query timeout
+            # To force an exception try a timeout value like 0.001 seconds
+            result = client.query(sql, timeout=3.0)
+            print("\nSecond query result\n", result)
+        except Exception as e:
+            print(f"Got exception on query: {e}")
+
+
+# To force timeout errors supply the corresponding command line arguments
+if __name__ == "__main__":
+    w_ct = DEFAULT_WRITE_TIMEOUT
+    q_ct = DEFAULT_QUERY_TIMEOUT
+    for index, arg in enumerate(sys.argv):
+        if index == 1:
+            w_ct = int(arg)
+        if index == 2:
+            q_ct = int(arg)
+
+    main(w_ct, q_ct)

{influxdb3_python-0.16.0 → influxdb3_python-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: influxdb3-python
-Version: 0.16.0
+Version: 0.18.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -33,6 +33,8 @@ Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-httpserver; extra == "test"
+Requires-Dist: h2<5.0.0,>=4.0.0; extra == "test"
+Requires-Dist: cryptography>=3.4.0; extra == "test"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -51,6 +53,9 @@ Dynamic: summary
 </p>
 
 <p align="center">
+    <a href="https://influxdb3-python.readthedocs.io/en/latest/">
+        <img src="https://img.shields.io/readthedocs/influxdb3-python/latest" alt="Readthedocs document">
+    </a>
     <a href="https://pypi.org/project/influxdb3-python/">
         <img src="https://img.shields.io/pypi/v/influxdb3-python.svg" alt="PyPI version">
     </a>
@@ -181,14 +186,46 @@ print(f'DONE writing from csv in {callback.write_count} batch(es)')
 
 ```
 
-### Pandas DF
+### Pandas DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pd_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import pandas as pd
+
+# Create a DataFrame with a timestamp column
+df = pd.DataFrame({
+    'time': pd.to_datetime(['2024-01-01', '2024-01-02', '2024-01-03']),
+    'trainer': ['Ash', 'Misty', 'Brock'],
+    'pokemon_id': [25, 120, 74],
+    'pokemon_name': ['Pikachu', 'Staryu', 'Geodude']
+})
+
+# Write the DataFrame - timestamp_column is required for consistency
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
-### Polars DF
+### Polars DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pl_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import polars as pl
+
+# Create a DataFrame with a timestamp column
+df = pl.DataFrame({
+    'time': ['2024-01-01T00:00:00Z', '2024-01-02T00:00:00Z'],
+    'trainer': ['Ash', 'Misty'],
+    'pokemon_id': [25, 120],
+    'pokemon_name': ['Pikachu', 'Staryu']
+})
+
+# Write the DataFrame - same API works for both pandas and polars
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
 ## Querying
@@ -201,6 +238,15 @@ table = reader.read_all()
 print(table.to_pandas().to_markdown())
 ```
 
+### Querying to DataFrame
+```python
+# Query directly to a pandas DataFrame (default)
+df = client.query_dataframe("SELECT * FROM caught WHERE trainer = 'Ash'")
+
+# Query to a polars DataFrame
+df = client.query_dataframe("SELECT * FROM caught", frame_type="polars")
+```
+
 ### Querying with influxql
 ```python
 query = "select * from measurement"
@@ -210,9 +256,32 @@ print(table.to_pandas().to_markdown())
 ```
 
 ### gRPC compression
-The Python client supports gRPC response compression.  
-If the server chooses to compress query responses (e.g., with gzip), the client
-will automatically decompress them — no extra configuration is required.
+
+#### Request compression
+
+Request compression is not supported by InfluxDB 3 — the client sends uncompressed requests.
+
+#### Response compression
+
+Response compression is enabled by default. The client sends the `grpc-accept-encoding: identity, deflate, gzip`
+header, and the server returns gzip-compressed responses (if supported). The client automatically
+decompresses them — no configuration required.
+
+To **disable response compression**:
+
+```python
+# Via constructor parameter
+client = InfluxDBClient3(
+    host="your-host",
+    token="your-token",
+    database="your-database",
+    disable_grpc_compression=True
+)
+
+# Or via environment variable
+# INFLUX_DISABLE_GRPC_COMPRESSION=true
+client = InfluxDBClient3.from_env()
+```
 
 ## Windows Users
 Currently, Windows users require an extra installation when querying via Flight natively. This is due to the fact gRPC cannot locate Windows root certificates. To work around this please follow these steps:
@@ -245,7 +314,8 @@ table = client.query(
 
 print(table.to_pandas())
 ```
-You may also include your own root certificate via this manor aswell.
+
+You may include your own root certificate in this manner as well.
 
 If connecting to InfluxDB fails with error `DNS resolution failed` when using domain name, example `www.mydomain.com`, then try to set environment variable `GRPC_DNS_RESOLVER=native` to see if it works.
 

{influxdb3_python-0.16.0 → influxdb3_python-0.18.0}/README.md

@@ -4,6 +4,9 @@
 </p>
 
 <p align="center">
+    <a href="https://influxdb3-python.readthedocs.io/en/latest/">
+        <img src="https://img.shields.io/readthedocs/influxdb3-python/latest" alt="Readthedocs document">
+    </a>
     <a href="https://pypi.org/project/influxdb3-python/">
         <img src="https://img.shields.io/pypi/v/influxdb3-python.svg" alt="PyPI version">
     </a>
@@ -134,14 +137,46 @@ print(f'DONE writing from csv in {callback.write_count} batch(es)')
 
 ```
 
-### Pandas DF
+### Pandas DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pd_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import pandas as pd
+
+# Create a DataFrame with a timestamp column
+df = pd.DataFrame({
+    'time': pd.to_datetime(['2024-01-01', '2024-01-02', '2024-01-03']),
+    'trainer': ['Ash', 'Misty', 'Brock'],
+    'pokemon_id': [25, 120, 74],
+    'pokemon_name': ['Pikachu', 'Staryu', 'Geodude']
+})
+
+# Write the DataFrame - timestamp_column is required for consistency
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
-### Polars DF
+### Polars DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pl_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import polars as pl
+
+# Create a DataFrame with a timestamp column
+df = pl.DataFrame({
+    'time': ['2024-01-01T00:00:00Z', '2024-01-02T00:00:00Z'],
+    'trainer': ['Ash', 'Misty'],
+    'pokemon_id': [25, 120],
+    'pokemon_name': ['Pikachu', 'Staryu']
+})
+
+# Write the DataFrame - same API works for both pandas and polars
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
 ## Querying
@@ -154,6 +189,15 @@ table = reader.read_all()
 print(table.to_pandas().to_markdown())
 ```
 
+### Querying to DataFrame
+```python
+# Query directly to a pandas DataFrame (default)
+df = client.query_dataframe("SELECT * FROM caught WHERE trainer = 'Ash'")
+
+# Query to a polars DataFrame
+df = client.query_dataframe("SELECT * FROM caught", frame_type="polars")
+```
+
 ### Querying with influxql
 ```python
 query = "select * from measurement"
@@ -163,9 +207,32 @@ print(table.to_pandas().to_markdown())
 ```
 
 ### gRPC compression
-The Python client supports gRPC response compression.  
-If the server chooses to compress query responses (e.g., with gzip), the client
-will automatically decompress them — no extra configuration is required.
+
+#### Request compression
+
+Request compression is not supported by InfluxDB 3 — the client sends uncompressed requests.
+
+#### Response compression
+
+Response compression is enabled by default. The client sends the `grpc-accept-encoding: identity, deflate, gzip`
+header, and the server returns gzip-compressed responses (if supported). The client automatically
+decompresses them — no configuration required.
+
+To **disable response compression**:
+
+```python
+# Via constructor parameter
+client = InfluxDBClient3(
+    host="your-host",
+    token="your-token",
+    database="your-database",
+    disable_grpc_compression=True
+)
+
+# Or via environment variable
+# INFLUX_DISABLE_GRPC_COMPRESSION=true
+client = InfluxDBClient3.from_env()
+```
 
 ## Windows Users
 Currently, Windows users require an extra installation when querying via Flight natively. This is due to the fact gRPC cannot locate Windows root certificates. To work around this please follow these steps:
@@ -198,7 +265,8 @@ table = client.query(
 
 print(table.to_pandas())
 ```
-You may also include your own root certificate via this manor aswell.
+
+You may include your own root certificate in this manner as well.
 
 If connecting to InfluxDB fails with error `DNS resolution failed` when using domain name, example `www.mydomain.com`, then try to set environment variable `GRPC_DNS_RESOLVER=native` to see if it works.
 

{influxdb3_python-0.16.0 → influxdb3_python-0.18.0}/influxdb3_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: influxdb3-python
-Version: 0.16.0
+Version: 0.18.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -33,6 +33,8 @@ Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-httpserver; extra == "test"
+Requires-Dist: h2<5.0.0,>=4.0.0; extra == "test"
+Requires-Dist: cryptography>=3.4.0; extra == "test"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -51,6 +53,9 @@ Dynamic: summary
 </p>
 
 <p align="center">
+    <a href="https://influxdb3-python.readthedocs.io/en/latest/">
+        <img src="https://img.shields.io/readthedocs/influxdb3-python/latest" alt="Readthedocs document">
+    </a>
     <a href="https://pypi.org/project/influxdb3-python/">
         <img src="https://img.shields.io/pypi/v/influxdb3-python.svg" alt="PyPI version">
     </a>
@@ -181,14 +186,46 @@ print(f'DONE writing from csv in {callback.write_count} batch(es)')
 
 ```
 
-### Pandas DF
+### Pandas DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pd_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import pandas as pd
+
+# Create a DataFrame with a timestamp column
+df = pd.DataFrame({
+    'time': pd.to_datetime(['2024-01-01', '2024-01-02', '2024-01-03']),
+    'trainer': ['Ash', 'Misty', 'Brock'],
+    'pokemon_id': [25, 120, 74],
+    'pokemon_name': ['Pikachu', 'Staryu', 'Geodude']
+})
+
+# Write the DataFrame - timestamp_column is required for consistency
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
-### Polars DF
+### Polars DataFrame
 ```python
-client._write_api.write(bucket="pokemon-codex", record=pl_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
+import polars as pl
+
+# Create a DataFrame with a timestamp column
+df = pl.DataFrame({
+    'time': ['2024-01-01T00:00:00Z', '2024-01-02T00:00:00Z'],
+    'trainer': ['Ash', 'Misty'],
+    'pokemon_id': [25, 120],
+    'pokemon_name': ['Pikachu', 'Staryu']
+})
+
+# Write the DataFrame - same API works for both pandas and polars
+client.write_dataframe(
+    df,
+    measurement='caught',
+    timestamp_column='time',
+    tags=['trainer', 'pokemon_id']
+)
 ```
 
 ## Querying
@@ -201,6 +238,15 @@ table = reader.read_all()
 print(table.to_pandas().to_markdown())
 ```
 
+### Querying to DataFrame
+```python
+# Query directly to a pandas DataFrame (default)
+df = client.query_dataframe("SELECT * FROM caught WHERE trainer = 'Ash'")
+
+# Query to a polars DataFrame
+df = client.query_dataframe("SELECT * FROM caught", frame_type="polars")
+```
+
 ### Querying with influxql
 ```python
 query = "select * from measurement"
@@ -210,9 +256,32 @@ print(table.to_pandas().to_markdown())
 ```
 
 ### gRPC compression
-The Python client supports gRPC response compression.  
-If the server chooses to compress query responses (e.g., with gzip), the client
-will automatically decompress them — no extra configuration is required.
+
+#### Request compression
+
+Request compression is not supported by InfluxDB 3 — the client sends uncompressed requests.
+
+#### Response compression
+
+Response compression is enabled by default. The client sends the `grpc-accept-encoding: identity, deflate, gzip`
+header, and the server returns gzip-compressed responses (if supported). The client automatically
+decompresses them — no configuration required.
+
+To **disable response compression**:
+
+```python
+# Via constructor parameter
+client = InfluxDBClient3(
+    host="your-host",
+    token="your-token",
+    database="your-database",
+    disable_grpc_compression=True
+)
+
+# Or via environment variable
+# INFLUX_DISABLE_GRPC_COMPRESSION=true
+client = InfluxDBClient3.from_env()
+```
 
 ## Windows Users
 Currently, Windows users require an extra installation when querying via Flight natively. This is due to the fact gRPC cannot locate Windows root certificates. To work around this please follow these steps:
@@ -245,7 +314,8 @@ table = client.query(
 
 print(table.to_pandas())
 ```
-You may also include your own root certificate via this manor aswell.
+
+You may include your own root certificate in this manner as well.
 
 If connecting to InfluxDB fails with error `DNS resolution failed` when using domain name, example `www.mydomain.com`, then try to set environment variable `GRPC_DNS_RESOLVER=native` to see if it works.
 

{influxdb3_python-0.16.0 → influxdb3_python-0.18.0}/influxdb3_python.egg-info/SOURCES.txt

@@ -14,6 +14,8 @@ Examples/handle_query_error.py
 Examples/pandas_write.py
 Examples/query_async.py
 Examples/query_type.py
+Examples/query_with_middleware.py
+Examples/timeouts.py
 influxdb3_python.egg-info/PKG-INFO
 influxdb3_python.egg-info/SOURCES.txt
 influxdb3_python.egg-info/dependency_links.txt
@@ -62,6 +64,7 @@ tests/test_api_client.py
 tests/test_dataframe_serializer.py
 tests/test_date_helper.py
 tests/test_deep_merge.py
+tests/test_flush.py
 tests/test_influxdb_client_3.py
 tests/test_influxdb_client_3_integration.py
 tests/test_merge_options.py

{influxdb3_python-0.16.0 → influxdb3_python-0.18.0}/influxdb3_python.egg-info/requires.txt

@@ -18,3 +18,5 @@ polars
 pytest
 pytest-cov
 pytest-httpserver
+h2<5.0.0,>=4.0.0
+cryptography>=3.4.0