Skip to content

Commit

Permalink
docs: update driver status table (#1797)
Browse files Browse the repository at this point in the history
Fixes #1786.
  • Loading branch information
lidavidm authored Apr 30, 2024
1 parent 02aecca commit 25456bf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
9 changes: 9 additions & 0 deletions docs/source/driver/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,15 @@ The PostgreSQL driver mostly supports features defined in the ADBC API
specification 1.0.0, but not all cases are fully implemented
(particularly around bind parameters and prepared statements).

Bind Parameters and Prepared Statements
---------------------------------------

The PostgreSQL driver only supports executing prepared statements with
parameters that do not return result sets (basically, an INSERT with
parameters). Queries that return result sets are difficult with prepared
statements because the driver is built around using COPY for best
performance, which is not supported in this context.

Bulk Ingestion
--------------

Expand Down
22 changes: 14 additions & 8 deletions docs/source/driver/status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Implementation Status

**Experimental** drivers are not feature-complete and the implementation is still progressing.
**Beta** drivers are (mostly) feature-complete but have only been available for a short time.
**Stable** drivers are feature-complete (as much as possible for the underlying database) and have been available/tested for a while.
**Stable** drivers are (mostly) feature-complete (as much as possible for the underlying database) and have been available/tested for a while.

.. list-table::
:header-rows: 1
Expand All @@ -42,7 +42,7 @@ Implementation Status
* - Flight SQL (Go)
- C, Go
- Go
- Beta
- Stable

* - Flight SQL (Java)
- Java
Expand All @@ -57,17 +57,17 @@ Implementation Status
* - PostgreSQL
- C
- C++
- Beta
- Stable

* - SQLite
- C
- C
- Beta
- Stable

* - Snowflake
- C, Go
- Go
- Experimental
- Stable

.. [#supported-languages] C drivers are usable from Go, Python, and Ruby as well.
Expand Down Expand Up @@ -183,7 +183,7 @@ Update Queries
* - PostgreSQL
- N/A
- N/A
- Y
- Y [#postgresql-prepared]_
- Y
- Y
- Y
Expand All @@ -196,6 +196,12 @@ Update Queries
- Y
- Y

.. [#postgresql-prepared] The PostgreSQL driver only supports executing
prepared statements with parameters that do not return result sets
(basically, an INSERT with parameters). Queries that return result sets
are difficult with prepared statements because the driver is built around
using COPY for best performance, which is not supported in this context.
.. list-table:: Connection/database-level features
:header-rows: 1

Expand All @@ -207,7 +213,7 @@ Update Queries
* - Flight SQL (Go)
- N
- Y
- N
- Y

* - Flight SQL (Java)
- Y
Expand All @@ -222,7 +228,7 @@ Update Queries
* - PostgreSQL
- Y
- Y
- N
- Y

* - SQLite
- Y
Expand Down

0 comments on commit 25456bf

Please sign in to comment.