Skip to content

Commit a9c244a

Browse files
authored
feat: docs for pgwire clients (#175)
Guidance and best practices for all supported PGWire clients. ![Screenshot From 2025-05-09 19-08-04](https://github.com/user-attachments/assets/a197c349-b0de-4cce-9dd9-e175cb422c49)
1 parent a2661a9 commit a9c244a

File tree

22 files changed

+6259
-14
lines changed

22 files changed

+6259
-14
lines changed

documentation/clients/ingest-dotnet.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ perform basic insert operations.
2727

2828
<ILPClientsTable language=".NET" />
2929

30+
:::info
31+
32+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
33+
For retrieving data, we recommend using a [PostgreSQL-compatible .NET library](/docs/pgwire/c-sharp/) or our
34+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
35+
36+
:::
37+
38+
3039
## Requirements
3140

3241
- .NET 6.0 or higher is required.

documentation/clients/ingest-go.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ some common insert patterns.
2828

2929
<ILPClientsTable language="Golang" />
3030

31+
:::info
32+
33+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
34+
For retrieving data, we recommend using a [PostgreSQL-compatible Go library](/docs/pgwire/go/) or our
35+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
36+
37+
:::
38+
3139
## Requirements
3240

3341
- Requires Go 1.19 or later.

documentation/clients/ingest-node.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ QuestDB.
2727

2828
<ILPClientsTable language="NodeJS" />
2929

30+
:::info
31+
32+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
33+
For retrieving data, we recommend using a [PostgreSQL-compatible Node.js library](/docs/pgwire/javascript/) or our
34+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
35+
36+
:::
37+
38+
3039
## Requirements
3140

3241
- Node.js v16 or newer.

documentation/clients/ingest-python.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ It covers basic connection, authentication and some insert patterns.
3131

3232
<ILPClientsTable language="Python" />
3333

34+
:::info
35+
36+
37+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
38+
For retrieving data, we recommend using a [PostgreSQL-compatible Python library](/docs/pgwire/python/) or our
39+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
40+
41+
:::
42+
43+
3444
## Requirements
3545

3646
Requires Python >= 3.8 Assumes QuestDB is running. Not running? See the
@@ -270,3 +280,8 @@ To learn _The Way_ of QuestDB SQL, see the
270280

271281
Alone? Stuck? Want help? Visit us in our
272282
[Community Forum](https://community.questdb.com/).
283+
284+
## Additional resources
285+
- [QuestDB Python clients guide](/docs/pgwire/python/)
286+
- [Integration with Polars](/docs/third-party-tools/polars/)
287+
- [Integration with Pandas](/docs/third-party-tools/pandas/)

documentation/clients/ingest-rust.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ are some of the highlights:
1919

2020
<ILPClientsTable language="Rust" />
2121

22+
:::info
23+
24+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
25+
For retrieving data, we recommend using a [PostgreSQL-compatible Rust library](/docs/pgwire/rust/) or our
26+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
27+
28+
:::
29+
30+
2231
## Requirements
2332

2433
- Requires Rust 1.40 or later.

documentation/clients/java_ilp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ The client provides the following benefits:
3737
health monitoring
3838
- **Automatic write retries**: Reuse connections and retry after interruptions
3939

40+
:::info
41+
42+
This page focuses on our high-performance ingestion client, which is optimized for **writing** data to QuestDB.
43+
For retrieving data, we recommend using a [PostgreSQL-compatible Java library](/docs/pgwire/java/) or our
44+
[HTTP query endpoint](/docs/reference/sql/overview/#rest-http-api).
45+
46+
:::
47+
48+
4049
## Compatible JDKs
4150

4251
The client relies on some JDK internal libraries, which certain specialised JDK offerings may not support.

0 commit comments

Comments
 (0)