Skip to content

Commit 11b1c9e

Browse files
authored
cross-links pgwire guides (#184)
also: 1. removed dups/outdated info 2. typos (psychopg -> psycopg)
1 parent c71a4be commit 11b1c9e

File tree

4 files changed

+12
-62
lines changed

4 files changed

+12
-62
lines changed

documentation/concept/geohashes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,9 +490,9 @@ geohashes in text mode (i.e. as strings) as opposed to binary
490490

491491
The Python example below demonstrates how to connect to QuestDB over postgres
492492
wire, insert and query geohashes. It uses the
493-
[psychopg3](https://www.psycopg.org/psycopg3/docs/) adapter.
493+
[psycopg3](https://www.psycopg.org/psycopg3/docs/) adapter.
494494

495-
To install `psychopg3`, use `pip`:
495+
To install `psycopg3`, use `pip`:
496496

497497
```shell
498498
python3 -m pip install "psycopg[binary]"

documentation/partials/_python.sql.insert.partial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This example uses the [psychopg3](https://www.psycopg.org/psycopg3/docs/)
1+
This example uses the [psycopg3](https://www.psycopg.org/psycopg3/docs/)
22
adapter.
33

44
To [install](https://www.psycopg.org/psycopg3/docs/basic/install.html) the

documentation/reference/api/postgres.md

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import RustInsertPartial from "../../partials/_rust.sql.insert.partial.mdx"
1414

1515
QuestDB supports the Postgres Wire Protocol (PGWire) for data-in.
1616

17-
For querying and data-out, QuestDB is compatible with PostgreSQL queries.
17+
For querying and data-out, QuestDB is compatible with PostgreSQL protocol.
1818

1919
This means that you can use your favorite PostgreSQL client or driver with
2020
QuestDB.
@@ -26,7 +26,7 @@ For information querying and data-out, see the
2626

2727
The PostgreSQL storage model is fundamentally different than that of QuestDB.
2828

29-
As a result, some features that exists for Postgres do not exist in QuestDB.
29+
As a result, some features that exists for PostgreSQL do not exist in QuestDB.
3030

3131
:::
3232

@@ -80,12 +80,11 @@ For full query details and examples, see the PostgreSQL section in the
8080
### List of supported features
8181

8282
- Querying (all types expect `BLOB`)
83-
- Prepared statements with bind parameters (check for specific libraries
84-
[below](/docs/reference/api/postgres/#libraries--programmatic-clients))
83+
- Prepared statements with bind parameters
8584
- `INSERT` statements with bind parameters
8685
- `UPDATE` statements with bind parameters
8786
- DDL execution
88-
- Batch inserts with `JDBC`
87+
- Batch inserts
8988
- Plain authentication
9089

9190
### List of supported connection properties
@@ -106,34 +105,4 @@ For full query details and examples, see the PostgreSQL section in the
106105

107106
## Recommended third party tools
108107

109-
The following list of third party tools includes drivers, clients or utility
110-
CLIs that our team has tested extensively. Picking an item from it will
111-
guarantee that your code will work with QuestDB.
112-
113-
We recognize that our community might value some features more than others. This
114-
is why we encourage you to [open an issue on GitHub](https://github.com/questdb/questdb/issues) if
115-
you think we are missing something important for your workflow.
116-
117-
### CLIs
118-
119-
#### [PSQL](https://www.postgresql.org/docs/current/app-psql.html) `12`
120-
121-
Support for `SELECT`, `INSERT`, `UPDATE`, `CREATE`, `DROP`, `TRUNCATE`.
122-
123-
### Libraries / Programmatic clients
124-
125-
#### [node-postgres](https://node-postgres.com/) (NodeJS) `8.4`
126-
127-
#### [pq](https://github.com/lib/pq) (Go) `1.8`
128-
129-
#### [pq](https://www.postgresql.org/docs/12/libpq.html) (C) `12`
130-
131-
#### [Psycopg](https://www.psycopg.org) (Python) `2.9.3` and `3.1`
132-
133-
#### [ruby-pg](https://github.com/ged/ruby-pg) (Ruby) `1.4.3`
134-
135-
#### [pg_connect](https://www.php.net/manual/en/function.pg-connect.php) (PHP) `8.1.0`
136-
137-
### Drivers
138-
139-
#### [JDBC](https://jdbc.postgresql.org/) `42.2`
108+
See [PGWire client guides](/docs/pgwire/pgwire-intro/) for more information about supported PostgreSQL clients and libraries.

documentation/reference/sql/overview.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -142,29 +142,10 @@ Brief examples in multiple languages are shown below.
142142
</Tabs>
143143

144144

145-
#### Forward-only cursors
146-
147-
QuestDB diverges from PostgreSQL in its handling of
148-
[cursor commands](https://www.postgresql.org/docs/current/plpgsql-cursors.html).
149-
While PostgreSQL supports scrollable cursors, enabling backward and forward
150-
navigation through the results of a SQL query, QuestDB applies a different
151-
approach.
152-
153-
QuestDB does not support scrollable cursors that require explicit creation and
154-
management through `DECLARE CURSOR` and subsequent operations like `FETCH`.
155-
Instead, QuestDB supports non-scrollable, or "forward-only", cursors. This
156-
distinction means that while you can iterate over query results sequentially,
157-
you cannot navigate backwards or access result positions as you might with
158-
scrollable cursors in PostgreSQL.
159-
160-
As a result, some PostgreSQL drivers and libraries that rely on scrollable
161-
cursors may not be fully compatible with QuestDB. For instance,
162-
[psycopg2](https://pypi.org/project/psycopg2/) — a popular PostgreSQL driver for
163-
Python — utilizes scrollable cursors extensively. If possible, select drivers
164-
that support non-scrollable cursors for optimal compatibility. One such example
165-
is
166-
[asyncpg](https://magicstack.github.io/asyncpg/current/api/index.html#cursors),
167-
which is database driver for asyncio and PostgreSQL.
145+
#### Further Reading
146+
147+
See the [PGWire Client overview](/docs/pgwire/pgwire-intro/) for more details on how to use PostgreSQL
148+
clients to connect to QuestDB.
168149

169150
## REST HTTP API
170151

0 commit comments

Comments
 (0)