From b301530a5fd50fe8ee46149fec58162a52bed8c6 Mon Sep 17 00:00:00 2001 From: Lev Zakharov Date: Fri, 8 Sep 2023 12:54:10 +0300 Subject: [PATCH] add doc for OpenDBFromPool --- stdlib/sql.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/stdlib/sql.go b/stdlib/sql.go index aa20da80..6a081e21 100644 --- a/stdlib/sql.go +++ b/stdlib/sql.go @@ -223,6 +223,9 @@ func OpenDB(config pgx.ConnConfig, opts ...OptionOpenDB) *sql.DB { return sql.OpenDB(c) } +// OpenDBFromPool creates a new *sql.DB from the given *pgxpool.Pool. Note that this method automatically sets the +// maximum number of idle connections in *sql.DB to zero, since they must be managed from the *pgxpool.Pool. This is +// required to avoid acquiring all the connections from the pgxpool and starving any direct users of the pgxpool. func OpenDBFromPool(pool *pgxpool.Pool, opts ...OptionOpenDB) *sql.DB { c := GetPoolConnector(pool, opts...) db := sql.OpenDB(c)