Skip to content

Don't encourage people to use pool.on('connect', ...) for setup anymore #3623

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

Merged
brianc merged 1 commit into from
Mar 5, 2026
+4 −7
Merged

Don't encourage people to use pool.on('connect', ...) for setup anymore #3623

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
11 changes: 4 additions & 7 deletions docs/pages/apis/pool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,11 @@ The number of queued requests waiting on a client when all clients are checked o

`pool.on('connect', (client: Client) => void) => void`

Whenever the pool establishes a new client connection to the PostgreSQL backend it will emit the `connect` event with the newly connected client. This presents an opportunity for you to run setup commands on a client.
Whenever the pool establishes a new client connection to the PostgreSQL backend it will emit the `connect` event with the newly connected client.

```js
const pool = new Pool()
pool.on('connect', (client) => {
client.query('SET DATESTYLE = iso, mdy')
})
```
<Alert>
The event listener does not wait for promises or async functions. If you want to run setup commands on each new client, use the `onConnect` option. (See documentation above.)
</Alert>

### acquire

Expand Down