summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-05-22 16:04:17 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-05-22 16:04:17 -0400
commit88ae6a6cdd9f37d65ea212736f1229bb62d677a9 (patch)
tree57dd6f191aedc0249afd4ff5c1e1b47ab2403f0f /lib
parent1d320fa48020407c997cb605c90b85e1ce15a89a (diff)
downloadsqlalchemy-88ae6a6cdd9f37d65ea212736f1229bb62d677a9.tar.gz
Cross reference do_connect() event w/ creator
two questions today involving creator / do_connect, do_connect is not well known enough, ensure docs are present and prominent. Change-Id: I85d518b9fc7b9b069a18010969abefa360134fe9
Diffstat (limited to 'lib')
-rw-r--r--lib/sqlalchemy/engine/create.py12
-rw-r--r--lib/sqlalchemy/engine/events.py4
2 files changed, 16 insertions, 0 deletions
diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index dbe1e8b57..e683b6297 100644
--- a/lib/sqlalchemy/engine/create.py
+++ b/lib/sqlalchemy/engine/create.py
@@ -122,6 +122,18 @@ def create_engine(url, **kwargs):
connections. Usage of this function causes connection
parameters specified in the URL argument to be bypassed.
+ This hook is not as flexible as the newer
+ :class:`_events.DialectEvents.do_connect` hook which allows complete
+ control over how a connection is made to the database, given the full
+ set of URL arguments and state beforehand.
+
+ .. seealso::
+
+ :class:`_events.DialectEvents.do_connect` - event hook that allows
+ full control over DBAPI connection mechanics.
+
+ :ref:`custom_dbapi_args`
+
:param echo=False: if True, the Engine will log all statements
as well as a ``repr()`` of their parameter lists to the default log
handler, which defaults to ``sys.stdout`` for output. If set to the
diff --git a/lib/sqlalchemy/engine/events.py b/lib/sqlalchemy/engine/events.py
index 759f7f2bd..293c7afdd 100644
--- a/lib/sqlalchemy/engine/events.py
+++ b/lib/sqlalchemy/engine/events.py
@@ -758,6 +758,10 @@ class DialectEvents(event.Events):
.. versionadded:: 1.0.3
+ .. seealso::
+
+ :ref:`custom_dbapi_args`
+
"""
def do_executemany(self, cursor, statement, parameters, context):