Skip to content

Commit 938f347

Browse files
committed
docs: update README.md and CHANGELOG.md
1 parent a3f5b7a commit 938f347

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
- `write_dataframe()`: New method for writing pandas and polars DataFrames with explicit parameters (`measurement`, `timestamp_column`, `tags`, `timestamp_timezone`).
99
- `query_dataframe()`: New method for querying data directly to a pandas or polars DataFrame via the `frame_type` parameter.
1010
- Updated README with clear examples for DataFrame operations.
11+
1. [#179](https://github.com/InfluxCommunity/influxdb3-python/pull/179): Add option to disable gRPC response
12+
compression for Flight queries:
13+
- `disable_grpc_compression` parameter in `InfluxDBClient3` constructor
14+
- `INFLUX_DISABLE_GRPC_COMPRESSION` environment variable support in `from_env()`
1115

1216
### Bug Fixes
1317

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,32 @@ print(table.to_pandas().to_markdown())
204204
```
205205

206206
### gRPC compression
207-
The Python client supports gRPC response compression.
208-
If the server chooses to compress query responses (e.g., with gzip), the client
209-
will automatically decompress them — no extra configuration is required.
207+
208+
#### Request compression
209+
210+
Request compression is not supported by InfluxDB 3 — the client sends uncompressed requests.
211+
212+
#### Response compression
213+
214+
Response compression is enabled by default. The client sends the `grpc-accept-encoding: identity, deflate, gzip`
215+
header, and the server returns gzip-compressed responses (if supported). The client automatically
216+
decompresses them — no configuration required.
217+
218+
To **disable response compression**:
219+
220+
```python
221+
# Via constructor parameter
222+
client = InfluxDBClient3(
223+
host="your-host",
224+
token="your-token",
225+
database="your-database",
226+
disable_grpc_compression=True
227+
)
228+
229+
# Or via environment variable
230+
# INFLUX_DISABLE_GRPC_COMPRESSION=true
231+
client = InfluxDBClient3.from_env()
232+
```
210233

211234
## Windows Users
212235
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:

0 commit comments

Comments
 (0)