diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-10-15 13:21:34 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-10-15 13:21:34 -0400 |
| commit | 41d3e16773e84692b6625ccb67da204b5362d9c3 (patch) | |
| tree | ae299d5a398e0d19fcaa256b0bdbc58544bed165 /lib/sqlalchemy/engine/interfaces.py | |
| parent | a2ea05800d142000208d4ce400ef1039316e1a5f (diff) | |
| download | sqlalchemy-41d3e16773e84692b6625ccb67da204b5362d9c3.tar.gz | |
indicate legacy ping recipe for handle_error cases
in prep for a new feature as part of #5648.
Change-Id: I6720b0ea797c188de5e8163f79fb7b7994d6e76e
Diffstat (limited to 'lib/sqlalchemy/engine/interfaces.py')
| -rw-r--r-- | lib/sqlalchemy/engine/interfaces.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/sqlalchemy/engine/interfaces.py b/lib/sqlalchemy/engine/interfaces.py index 27de5aaaf..b7bd3627b 100644 --- a/lib/sqlalchemy/engine/interfaces.py +++ b/lib/sqlalchemy/engine/interfaces.py @@ -1556,6 +1556,16 @@ class ExceptionContext(object): a connection and pool invalidation can be invoked or prevented by changing this flag. + + .. note:: The pool "pre_ping" handler enabled using the + :paramref:`_sa.create_engine.pool_pre_ping` parameter does **not** + consult this event before deciding if the "ping" returned false, + as opposed to receiving an unhandled error. For this use case, the + :ref:`legacy recipe based on engine_connect() may be used + <pool_disconnects_pessimistic_custom>`. A future API allow more + comprehensive customization of the "disconnect" detection mechanism + across all functions. + """ invalidate_pool_on_disconnect = True |