-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding a new partial for compatibility_flags and compatibility_date.
- Loading branch information
Showing
3 changed files
with
17 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,7 +30,6 @@ The command above will output the ID of your Hyperdrive, which you will need to | |
|
||
```toml | ||
# required for database drivers to function | ||
compatibility_flags = [ "nodejs_compat_v2" ] | ||
|
||
[[hyperdrive]] | ||
binding = "HYPERDRIVE" | ||
|
@@ -48,7 +47,7 @@ Hyperdrive uses Workers [TCP socket support](/workers/runtime-apis/tcp-sockets/# | |
| Driver | Documentation | Minimum Version Required | Notes | | ||
| ----------------------------- | ---------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| Postgres.js (**recommended**) | [https://github.com/porsager/postgres](https://github.com/porsager/postgres) | `[email protected]` | Supported in both Workers & Pages. | | ||
| node-postgres - `pg` | [https://node-postgres.com/](https://node-postgres.com/) | `[email protected]` | `8.11.4` introduced a bug with URL parsing and will not work. `8.11.5` fixes this. Requires the [`nodejs_compat_v2`](/workers/runtime-apis/nodejs/) compatibility flag to be set. Requires wrangler `3.78.7` or later. | | ||
| node-postgres - `pg` | [https://node-postgres.com/](https://node-postgres.com/) | `[email protected]` | `8.11.4` introduced a bug with URL parsing and will not work. `8.11.5` fixes this. Requires the [`nodejs_compat`](/workers/runtime-apis/nodejs/) `compatibility_flags` and the `compatibility_date` to be set. Requires wrangler `3.78.7` or later. | | ||
| Drizzle | [https://orm.drizzle.team/](https://orm.drizzle.team/) | `0.26.2`^ | | | ||
| Kysely | [https://kysely.dev/](https://kysely.dev/) | `0.26.3`^ | | | ||
| [rust-postgres](https://github.com/sfackler/rust-postgres) | [https://docs.rs/postgres/latest/postgres/](https://docs.rs/postgres/latest/postgres/) | `v0.19.8` | Use the [`query_typed`](https://docs.rs/postgres/latest/postgres/struct.Client.html#method.query_typed) method for best performance. | | ||
|
@@ -97,14 +96,9 @@ Install the `node-postgres` driver: | |
npm install pg | ||
``` | ||
|
||
**Ensure you have `compatibility_flags = ["nodejs_compat_v2"]` set in your `wrangler.toml` configuration file**: | ||
**Ensure you have `compatibility_flags` and `compatibility_date` set in your `wrangler.toml` configuration file** as shown below: | ||
|
||
```toml | ||
# other fields elided | ||
# | ||
# Required for node-postgres to work | ||
compatibility_flags = ["nodejs_compat_v2"] | ||
``` | ||
<Render file="nodejs-compat-wrangler-toml" product="workers" /> | ||
|
||
Create a new `Client` instance and pass the Hyperdrive parameters: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
src/content/partials/workers/nodejs-compat-wrangler-toml.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
{} | ||
|
||
--- | ||
|
||
```toml title="wrangler.toml" | ||
# other fields elided | ||
# | ||
# Required for node-postgres to work | ||
compatibility_flags = [ "nodejs_compat" ] | ||
compatibility_date = "2024-09-23" | ||
``` |