From d23266decb2129f6b5a32d4b613fd33ce9517a9d Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Fri, 17 Mar 2023 10:13:08 +0100 Subject: [PATCH] docs: clarify that we don't support multi-host db urls (#3312) This PR updates the docs to clarify that we don't support multi-host strings in the databaseUrl configuration variable. The docs used to just mention that we accept libpq strings, but as reported in #3221, we **don't** support multi-host strings. I did some digging and found that this is because [node-postgres -- the library we use to connect to postgres -- itself does not support multi-host strings](https://github.com/brianc/node-postgres/issues/2308). To fix this, we would need to replace the library we use or otherwise wrap it. While this would be a better long-term solution, we don't have the capacity to it right now. But we can update the docs to better reflect reality. --- website/docs/reference/deploy/configuring-unleash.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/reference/deploy/configuring-unleash.md b/website/docs/reference/deploy/configuring-unleash.md index cb904cafc7..f0c35fda47 100644 --- a/website/docs/reference/deploy/configuring-unleash.md +++ b/website/docs/reference/deploy/configuring-unleash.md @@ -243,11 +243,11 @@ The available options are listed in the table below. Options can be specified ei | `applicationName` | `DATABASE_APPLICATION_NAME` | `unleash` | The name of the application that created this Client instance. | | `schema` | `DATABASE_SCHEMA` | `public` | The schema to use in the database. | -Alternatively, you can use a [libpq connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) to connect to the database. You can provide it directly or from a file by using one of the below options. In JavaScript, these are top-level properties of the root configuration object, _not_ the `db` object. +Alternatively, you can use a single-host [libpq connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) to connect to the database. You can provide it directly or from a file by using one of the below options. In JavaScript, these are top-level properties of the root configuration object, _not_ the `db` object. | Property name | Environment variable | Default value | Description | | --- | --- | --- | --- | -| `databaseUrl` | `DATABASE_URL` | N/A | A string that matches the [libpq connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING), such as `postgres://USER:PASSWORD@HOST:PORT/DATABASE`. | +| `databaseUrl` | `DATABASE_URL` | N/A | A string that matches a single-host [libpq connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING), such as `postgres://USER:PASSWORD@HOST:PORT/DATABASE`. Unleash does **not** support using multiple hosts. | | `databaseUrlFile` | `DATABASE_URL_FILE` | N/A | The path to a file that contains a [libpq connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING). | Below is an example JavaScript configuration object.