Skip to content

Commit 61c6459

Browse files
authored
docs: document node-postgres support (#489)
* docs: document node-postgres support * docs: update node-postgres support * docs: document untyped parameters behavior
1 parent 00d249a commit 61c6459

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ PGAdapter can be used with the following drivers and clients:
99
2. `JDBC`: Versions 42.x and higher are supported. See [JDBC support](docs/jdbc.md) for more details.
1010
3. `pgx`: Version 4.15 and higher are supported. See [pgx support](docs/pgx.md) for more details.
1111
4. `psycopg2`: Version 2.9.3 and higher (but not `psycopg3`) are supported. See [psycopg2](docs/psycopg2.md) for more details.
12-
5. `node-postgres`: Version 8.8.0 and higher have __experimental support__.
13-
See [node-postgres support](docs/node-postgres.md) for more details.
12+
5. `node-postgres`: Version 8.8.0 and higher are supported. See [node-postgres support](docs/node-postgres.md) for more details.
1413

1514
## Frameworks
1615
PGAdapter can be used with the following frameworks:

docs/node-postgres.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# Google Cloud Spanner PGAdapter - node-postgres Experimental Support
1+
# PGAdapter - node-postgres Connection Options
22

3-
PGAdapter has __experimental support__ for the [node-postgres driver](https://node-postgres.com/)
4-
version 8.8.0 and higher.
3+
PGAdapter supports the [node-postgres driver](https://node-postgres.com/) version 8.8.0 and higher.
54

65
## Usage
76

@@ -116,3 +115,8 @@ console.log(res);
116115
```
117116

118117
## Limitations
118+
- `node-postgres` always uses untyped query parameters encoded as strings. Cloud Spanner requires
119+
query parameters to be typed. PGAdapter therefore infers the types of the query parameters the
120+
first time it sees a given SQL string by analyzing the SQL statement and caching the result on the
121+
connection. This means that the first execution of a SQL statement with query parameters on a
122+
connection will be slightly slower than the following executions.

0 commit comments

Comments
 (0)