Skip to content

docs(pg-pool): use connectionString for a database URL in README #3861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ragib-mrb wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −27
Open

docs(pg-pool): use connectionString for a database URL in README #3861

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 5 additions & 27 deletions packages/pg-pool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,37 +50,15 @@ const pgNativePool = new Pool({ Client: PgNativeClient })

##### Note:

The Pool constructor does not support passing a Database URL as the parameter. To use pg-pool on heroku, for example, you need to parse the URL into a config object. Here is an example of how to parse a Database URL.
The Pool constructor does not support passing a Database URL as the parameter. To connect with a Database URL, for example on heroku, pass it as the `connectionString` option instead. It is passed to each client, which parses it.

@charmander charmander Nov 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Pool constructor does not support passing a Database URL as the parameter. To connect with a Database URL, for example on heroku, pass it as the `connectionString` option instead. It is passed to each client, which parses it.
To connect with a [connection URI](https://node-postgres.com/features/connecting#connection-uri), pass it as the `connectionString` client option.


```js
const Pool = require('pg-pool')
const url = require('url')

const params = url.parse(process.env.DATABASE_URL)
const auth = params.auth.split(':')

const config = {
user: auth[0],
password: auth[1],
host: params.hostname,
port: params.port,
database: params.pathname.split('/')[1],
ssl: true,
}

const pool = new Pool(config)

/*
Transforms, 'postgres://DBuser:secret@DBHost:#####/myDB', into
config = {
user: 'DBuser',
password: 'secret',
host: 'DBHost',
port: '#####',
database: 'myDB',
ssl: true
}
*/
const pool = new Pool({
connectionString: process.env.DATABASE_URL,
max: 20,
})
```

### acquire clients with a promise
Expand Down
Loading