summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/exc.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sqlalchemy/exc.py')
-rw-r--r--lib/sqlalchemy/exc.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/sqlalchemy/exc.py b/lib/sqlalchemy/exc.py
index d375807b2..57ddb11ef 100644
--- a/lib/sqlalchemy/exc.py
+++ b/lib/sqlalchemy/exc.py
@@ -63,7 +63,10 @@ class DisconnectionError(SQLAlchemyError):
"""A disconnect is detected on a raw DB-API connection.
This error is raised and consumed internally by a connection pool. It can
- be raised by a ``PoolListener`` so that the host pool forces a disconnect.
+ be raised by the :meth:`.PoolEvents.checkout` event
+ so that the host pool forces a retry; the exception will be caught
+ three times in a row before the pool gives up and raises
+ :class:`~sqlalchemy.exc.InvalidRequestError` regarding the connection attempt.
"""