From 897c0d092f2557e1d740771c2cbfca590e603fd9 Mon Sep 17 00:00:00 2001 From: Jun Lee Date: Fri, 11 Oct 2024 14:55:48 +0100 Subject: [PATCH] Adding a new partial for compatibility_flags and compatibility_date. --- .../hyperdrive/configuration/connect-to-postgres.mdx | 12 +++--------- .../index.mdx | 4 ++-- .../partials/workers/nodejs-compat-wrangler-toml.mdx | 12 ++++++++++++ 3 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 src/content/partials/workers/nodejs-compat-wrangler-toml.mdx diff --git a/src/content/docs/hyperdrive/configuration/connect-to-postgres.mdx b/src/content/docs/hyperdrive/configuration/connect-to-postgres.mdx index 5ab6648897361b..d82fdfad0b1437 100644 --- a/src/content/docs/hyperdrive/configuration/connect-to-postgres.mdx +++ b/src/content/docs/hyperdrive/configuration/connect-to-postgres.mdx @@ -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) | `postgres@3.4.4` | Supported in both Workers & Pages. | -| node-postgres - `pg` | [https://node-postgres.com/](https://node-postgres.com/) | `pg@8.13.0` | `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/) | `pg@8.13.0` | `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"] -``` + Create a new `Client` instance and pass the Hyperdrive parameters: diff --git a/src/content/docs/hyperdrive/tutorials/serverless-timeseries-api-with-timescale/index.mdx b/src/content/docs/hyperdrive/tutorials/serverless-timeseries-api-with-timescale/index.mdx index 1a10e806fd3acc..e24db30c9a962a 100644 --- a/src/content/docs/hyperdrive/tutorials/serverless-timeseries-api-with-timescale/index.mdx +++ b/src/content/docs/hyperdrive/tutorials/serverless-timeseries-api-with-timescale/index.mdx @@ -145,8 +145,8 @@ This command outputs your Hyperdrive ID. You can now bind your Hyperdrive config ```toml name = "timescale-api" main = "src/index.ts" -compatibility_date = "2024-08-21" -compatibility_flags = [ "nodejs_compat_v2"] +compatibility_date = "DATE" +compatibility_flags = [ "nodejs_compat"] [[hyperdrive]] binding = "HYPERDRIVE" diff --git a/src/content/partials/workers/nodejs-compat-wrangler-toml.mdx b/src/content/partials/workers/nodejs-compat-wrangler-toml.mdx new file mode 100644 index 00000000000000..acf781cf90de59 --- /dev/null +++ b/src/content/partials/workers/nodejs-compat-wrangler-toml.mdx @@ -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" +```