Commit cb5ff71

committed

fix: return str instead of urllib3.HTTPResponse for InfluxDBClient.QueryAPI.query_raw

1 parent 2f9e5ed commit cb5ff71Copy full SHA for cb5ff71

File tree

+26

-4

lines changed

+26

-4

lines changed

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,32 @@`
`1`	`1`	`## 1.39.0 [unreleased]`
`2`	`2`
	`3`	`+### Breaking Changes`
	`4`	`+`
	`5`	+1. [#569](https://github.com/influxdata/influxdb-client-python/pull/569): Return `str` instead of `urllib3.HTTPResponse` for `InfluxDBClient.QueryAPI.query_raw`.
	`6`	`+`
	`7`	+This fixes `InfluxDBClient.query_raw` that returned the wrong type based on the documentation.
	`8`	+The `AsyncInfluxDBClient` is not affected.
	`9`	`+`
	`10`	`+To make your code compatible with this version, you can remove the step of retrieving the response content:`
	`11`	`+`
	`12`	+```diff
	`13`	`+from influxdb_client.client import InfluxDBClient`
	`14`	`+`
	`15`	`+with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:`
	`16`	`+ query = "..."`
	`17`	`+ result = client.query_raw(query=query)`
	`18`	`+- content = result.data.decode("utf8")`
	`19`	`++ content = result`
	`20`	+```
	`21`	`+`
	`22`	`+`
`3`	`23`	`## 1.38.0 [2023年10月02日]`
`4`	`24`
`5`	`25`	`### Bug Fixes`
`6`	`26`	`1. [#601](https://github.com/influxdata/influxdb-client-python/pull/601): Use HTTResponse.headers to clear deprecation warning [urllib3]`
`7`	`27`	`1. [#610](https://github.com/influxdata/influxdb-client-python/pull/601): Use iloc to clear deprecation warning`
`8`	`28`
	`29`	`+`
`9`	`30`	`### Documentation`
`10`	`31`	1. [#566](https://github.com/influxdata/influxdb-client-python/pull/566): Fix Sphinx documentation build and add support `.readthedocs.yml` V2 configuration file
`11`	`32`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`from influxdb_client import Dialect`
`10`	`10`	`from influxdb_client.client._base import _BaseQueryApi`
`11`	`11`	`from influxdb_client.client.flux_table import FluxRecord, TableList, CSVIterator`
	`12`	`+from influxdb_client.rest import _UTF_8_encoding`
`12`	`13`
`13`	`14`
`14`	`15`	`class QueryOptions(object):`
`@@ -121,8 +122,8 @@ def query_raw(self, query: str, org=None, dialect=_BaseQueryApi.default_dialect,`
`121`	`122`	`org = self._org_param(org)`
`122`	`123`	`result = self._query_api.post_query(org=org, query=self._create_query(query, dialect, params), async_req=False,`
`123`	`124`	`_preload_content=False)`
`124`		`-`
`125`		`- return result`
	`125`	`+raw_bytes=result.data`
	`126`	`+ return raw_bytes.decode(_UTF_8_encoding)`
`126`	`127`
`127`	`128`	`def query(self, query: str, org=None, params: dict = None) -> TableList:`
`128`	`129`	"""Execute synchronous Flux query and return result as a :class:`~influxdb_client.client.flux_table.FluxTable` list.

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import codecs`
`2`	`1`	`import http.server`
`3`	`2`	`import json`
`4`	`3`	`import logging`
`@@ -346,7 +345,8 @@ def test_query_and_debug(self):`
`346`	`345`	`self.assertIn("my-bucket", list(map(lambda record: record["name"], results[0].records)))`
`347`	`346`	`# Query RAW`
`348`	`347`	`results = self.client.query_api().query_raw("buckets()", "my-org")`
`349`		`- self.assertIn("my-bucket", codecs.decode(results.data))`
	`348`	`+ self.assertIn("my-bucket", results)`
	`349`	`+ self.assertTrue(isinstance(results, str))`
`350`	`350`	`# Bucket API`
`351`	`351`	`results = self.client.buckets_api().find_buckets()`
`352`	`352`	`self.assertIn("my-bucket", list(map(lambda bucket: bucket.name, results.buckets)))`

Comments

(0)