summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/dialects/postgresql/asyncpg.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2023-04-21 15:00:47 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2023-04-21 15:05:47 -0400
commit553dcbc11cf9401b85bc2aab55977eb1925cf262 (patch)
tree7d7a154947ce2a0e30752fa379abd4b64a235686 /lib/sqlalchemy/dialects/postgresql/asyncpg.py
parent69ba6e3cf771dce93b18350ab6b4a4ab79604b40 (diff)
downloadsqlalchemy-553dcbc11cf9401b85bc2aab55977eb1925cf262.tar.gz
changelog fixes; edits
Change-Id: I6bbef2416f864d1414d56f9bf39026156aed5e67
Diffstat (limited to 'lib/sqlalchemy/dialects/postgresql/asyncpg.py')
-rw-r--r--lib/sqlalchemy/dialects/postgresql/asyncpg.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/sqlalchemy/dialects/postgresql/asyncpg.py b/lib/sqlalchemy/dialects/postgresql/asyncpg.py
index 0c7f17ce9..c879205e4 100644
--- a/lib/sqlalchemy/dialects/postgresql/asyncpg.py
+++ b/lib/sqlalchemy/dialects/postgresql/asyncpg.py
@@ -108,7 +108,7 @@ can lead to errors if a name has already been taken for another prepared
statement. This issue can arise if your application uses database proxies
such as PgBouncer to handle connections. One possible workaround is to
use dynamic prepared statement names, which asyncpg now supports through
-an optional name value for the statement name. This allows you to
+an optional ``name`` value for the statement name. This allows you to
generate your own unique names that won't conflict with existing ones.
To achieve this, you can provide a function that will be called every time
a prepared statement is prepared::
@@ -130,9 +130,9 @@ a prepared statement is prepared::
https://github.com/sqlalchemy/sqlalchemy/issues/6467
.. warning:: To prevent a buildup of useless prepared statements in
- your application, it's important to use the NullPool poolclass and
- PgBouncer with a configured `DISCARD https://www.postgresql.org/docs/current/sql-discard.html`_
- setup. The DISCARD command is used to release resources held by the db connection,
+ your application, it's important to use the :class:`.NullPool` pool
+ class, and to configure PgBouncer to use `DISCARD <https://www.postgresql.org/docs/current/sql-discard.html>`_
+ when returning connections. The DISCARD command is used to release resources held by the db connection,
including prepared statements. Without proper setup, prepared statements can
accumulate quickly and cause performance issues.