]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
update logging_name doc
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 13 Jan 2025 13:14:14 +0000 (08:14 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 13 Jan 2025 13:15:28 +0000 (08:15 -0500)
engine logging has not used hex-strings in a very long time

Change-Id: I77131e3eb2f72129fde1d9ab6dd4b4e40bc313c6
(cherry picked from commit 214088c42ad61794e315174c41ee92a3c408ae6c)

doc/build/core/engines.rst

index d52ad6b13c137ca0564fced460b246d43651d6b4..42c21d12430171867d7b9bd45984614daa9ef515 100644 (file)
@@ -641,12 +641,16 @@ getting duplicate log lines.
 Setting the Logging Name
 -------------------------
 
-The logger name of instance such as an :class:`~sqlalchemy.engine.Engine` or
-:class:`~sqlalchemy.pool.Pool` defaults to using a truncated hex identifier
-string. To set this to a specific name, use the
+The logger name for :class:`~sqlalchemy.engine.Engine` or
+:class:`~sqlalchemy.pool.Pool` is set to be the module-qualified class name of the
+object.  This name can be further qualified with an additional name
+using the
 :paramref:`_sa.create_engine.logging_name` and
-:paramref:`_sa.create_engine.pool_logging_name`  with
-:func:`sqlalchemy.create_engine`::
+:paramref:`_sa.create_engine.pool_logging_name` parameters with
+:func:`sqlalchemy.create_engine`; the name will be appended to existing
+class-qualified logging name.   This use is recommended for applications that
+make use of multiple global :class:`.Engine` instances simultaenously, so
+that they may be distinguished in logging::
 
     >>> from sqlalchemy import create_engine
     >>> from sqlalchemy import text