summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/interfaces.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-08-07 14:51:33 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-08-07 18:01:49 -0400
commit302e8dee82718df6c3a46de4c5283bdae51a650a (patch)
tree0df6953aba01b6ff72a7094ff0887d11c4a700f0 /lib/sqlalchemy/engine/interfaces.py
parent40d64f3a525b14272b7354c72d7f84f6b00796f9 (diff)
downloadsqlalchemy-302e8dee82718df6c3a46de4c5283bdae51a650a.tar.gz
Don't link on_connect to first_connect event handler
Adjusted the dialect initialization process such that the :meth:`_engine.Dialect.on_connect` is not called a second time on the first connection. The hook is called first, then the :meth:`_engine.Dialect.initialize` is called if that connection is the first for that dialect, then no more events are called. This eliminates the two calls to the "on_connect" function which can produce very difficult debugging situations. Fixes: #5497 Change-Id: Icefc2e884e30ee7b4ac84b99dc54bf992a6085e3
Diffstat (limited to 'lib/sqlalchemy/engine/interfaces.py')
-rw-r--r--lib/sqlalchemy/engine/interfaces.py18
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/sqlalchemy/engine/interfaces.py b/lib/sqlalchemy/engine/interfaces.py
index 1baef29af..7d51ab159 100644
--- a/lib/sqlalchemy/engine/interfaces.py
+++ b/lib/sqlalchemy/engine/interfaces.py
@@ -208,6 +208,9 @@ class Dialect(object):
The initialize() method of the base dialect should be called via
super().
+ .. note:: as of SQLAlchemy 1.4, this method is called **before**
+ any :meth:`_engine.Dialect.on_connect` hooks are called.
+
"""
pass
@@ -745,16 +748,13 @@ class Dialect(object):
isolation modes, Unicode modes, etc.
The "do_on_connect" callable is invoked by using the
- :meth:`_events.PoolEvents.first_connect` and
:meth:`_events.PoolEvents.connect` event
- hooks, then unwrapping the DBAPI connection and passing it into the
- callable. The reason it is invoked for both events is so that any
- dialect-level initialization that occurs upon first connection, which
- also makes use of the :meth:`_events.PoolEvents.first_connect` method,
- will
- proceed after this hook has been called. This currently means the
- hook is in fact called twice for the very first connection in which a
- dialect creates; and once per connection afterwards.
+ hook, then unwrapping the DBAPI connection and passing it into the
+ callable.
+
+ .. versionchanged:: 1.4 the on_connect hook is no longer called twice
+ for the first connection of a dialect. The on_connect hook is still
+ called before the :meth:`_engine.Dialect.initialize` method however.
If None is returned, no event listener is generated.