Skip to content

Commit d3e7ee1

Browse files
authored
Make query client not experimental (#1234)
1 parent 42a00a0 commit d3e7ee1

File tree

12 files changed

+8
-18
lines changed

12 files changed

+8
-18
lines changed

docs/how-to-guides/query-api.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,15 @@ While you can [make direct HTTP requests](#making-direct-http-requests) to Logfi
3030
we provide Python clients to simplify the process of interacting with the API from Python.
3131

3232
Logfire provides both synchronous and asynchronous clients.
33-
These clients are currently experimental, meaning we might introduce breaking changes in the future.
34-
To use these clients, you can import them from the `experimental` namespace:
33+
To use these clients, you can import them from the `query_client` namespace:
3534

3635
```python
37-
from logfire.experimental.query_client import AsyncLogfireQueryClient, LogfireQueryClient
36+
from logfire.query_client import AsyncLogfireQueryClient, LogfireQueryClient
3837
```
3938

4039
!!! note "Additional required dependencies"
4140

42-
To use the query clients provided in `logfire.experimental.query_client`, you need to install `httpx`.
41+
To use the query clients provided in `logfire.query_client`, you need to install `httpx`.
4342

4443
If you want to retrieve Arrow-format responses, you will also need to install `pyarrow`.
4544

@@ -57,7 +56,7 @@ Here's an example of how to use these clients:
5756
from io import StringIO
5857

5958
import polars as pl
60-
from logfire.experimental.query_client import AsyncLogfireQueryClient
59+
from logfire.query_client import AsyncLogfireQueryClient
6160

6261

6362
async def main():
@@ -105,7 +104,7 @@ Here's an example of how to use these clients:
105104
from io import StringIO
106105

107106
import polars as pl
108-
from logfire.experimental.query_client import LogfireQueryClient
107+
from logfire.query_client import LogfireQueryClient
109108

110109

111110
def main():
@@ -217,10 +216,3 @@ The Logfire API supports various response formats and query parameters to give y
217216
- **`row_oriented`**: Only affects JSON responses. If set to `true`, the JSON response will be row-oriented; otherwise, it will be column-oriented.
218217

219218
All query parameters besides `sql` are optional and can be used in any combination to tailor the API response to your needs.
220-
221-
### Important Notes
222-
223-
- **Experimental Feature**: The query clients are under the `experimental` namespace, indicating that the API may change in future versions.
224-
- **Environment Configuration**: Remember to securely store your read token in environment variables or a secure vault for production use.
225-
226-
With read tokens, you have the flexibility to integrate Logfire into your workflow, whether using Python scripts, data analysis tools, or other systems.

logfire/query_client.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# For git history and backwards compatibility, everything is kept in the experimental module.
2+
from .experimental.query_client import * # noqa

tests/aaa_query_client/README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)