MagicStack / MagicStack/asyncpg

Support a Pool `before_connect` callback to be used before a connection is created

Open
#1,118 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.1k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

* **asyncpg version**: 0.27.0
* **PostgreSQL version**: 14
* **Do you use a PostgreSQL SaaS? If so, which? Can you reproduce
the issue with a local PostgreSQL install?**: Local
* **Python version**: 3.9.9
* **Platform**: macos
* **Do you use pgbouncer?**: no
* **Did you install asyncpg with pip?**: yes
* **If you built asyncpg locally, which version of Cython did you use?**:
* **Can the issue be reproduced under both asyncio and
[uvloop](https://github.com/magicstack/uvloop)?**:

Hello! This is more of a feature request but I was wondering if there could be support for having a `before_connect` or similar callback when creating a Pool object that would run before a new connection is created? I see there is already an [init](https://github.com/MagicStack/asyncpg/blob/c2c8d20ba8c0057b0e0bc08bd892abc36862e553/asyncpg/pool.py#L1088-L1094) param which is run after a connection is made.

Our use case is that we use dynamic credentials to access our postgres database and want to make sure that when we create a connection we are using credentials that are not stale. Is this something that makes sense for this project? There is similar functionality in other libraries such as [sqlalchemy](https://docs.sqlalchemy.org/en/20/core/events.html#sqlalchemy.events.DialectEvents.do_connect) or [pgx](https://github.com/jackc/pgx/blob/5c63f646f820ca9696fc3515c1caf2a557d562e5/pgxpool/pool.go#L107-L109).

I was looking at how to do this as-is and there were two currently that I was exploring. One way would be to create our own Pool class which seems like a lot of maintainance for what we'd like to do. The other looked at creating a subclass and overriding the `acquire` and using `set_connect_args` but that would run every time we get a connection from a pool which would be wasteful as opposed to just when the creation happens.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with asyncpg/pool.py, especially the existing init callback and the acquire/set_connect_args paths described in the issue, to understand when connections are created versus checked out. Done means a before-connect hook can refresh dynamic credentials only when a new pool connection is created, rather than on every acquire.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python
Domain
database
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.