summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/create.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-10-24 12:59:22 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-10-24 12:59:22 -0400
commita1c51879aeb7811a23e454d2e90ad3bbae92b7a1 (patch)
tree1f618306053f59d8b66800fcc449905a7368f9a8 /lib/sqlalchemy/engine/create.py
parent91e14cc42c3c715f57db7d910761dfd5dd55e2b1 (diff)
downloadsqlalchemy-a1c51879aeb7811a23e454d2e90ad3bbae92b7a1.tar.gz
improve engine logging docs
the text here was a little confusing and didn't refer to major configurational elements such as hide_parameters. Change-Id: I4e2179e5a64c326d30b65a8871b924725c41b453
Diffstat (limited to 'lib/sqlalchemy/engine/create.py')
-rw-r--r--lib/sqlalchemy/engine/create.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/lib/sqlalchemy/engine/create.py b/lib/sqlalchemy/engine/create.py
index d6f1cb657..365a72a96 100644
--- a/lib/sqlalchemy/engine/create.py
+++ b/lib/sqlalchemy/engine/create.py
@@ -147,6 +147,7 @@ def create_engine(url, **kwargs):
:ref:`dbengine_logging` - further detail on how to configure
logging.
+
:param echo_pool=False: if True, the connection pool will log
informational output such as when connections are invalidated
as well as when connections are recycled to the default log handler,
@@ -242,6 +243,11 @@ def create_engine(url, **kwargs):
.. versionadded:: 1.3.8
+ .. seealso::
+
+ :ref:`dbengine_logging` - further detail on how to configure
+ logging.
+
:param implicit_returning=True: When ``True``, a RETURNING-
compatible construct, if available, will be used to
fetch newly generated primary key values when a single row
@@ -321,6 +327,13 @@ def create_engine(url, **kwargs):
"sqlalchemy.engine" logger. Defaults to a hexstring of the
object's id.
+ .. seealso::
+
+ :ref:`dbengine_logging` - further detail on how to configure
+ logging.
+
+
+
:param max_identifier_length: integer; override the max_identifier_length
determined by the dialect. if ``None`` or zero, has no effect. This
is the database's configured maximum number of characters that may be
@@ -380,6 +393,13 @@ def create_engine(url, **kwargs):
"sqlalchemy.pool" logger. Defaults to a hexstring of the object's
id.
+
+ .. seealso::
+
+ :ref:`dbengine_logging` - further detail on how to configure
+ logging.
+
+
:param pool_pre_ping: boolean, if True will enable the connection pool
"pre-ping" feature that tests connections for liveness upon
each checkout.