]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Pool logging documentation bug
authorjaskiratsingh <jaskirat.singh@partners.rivigo.com>
Tue, 2 Apr 2019 17:14:48 +0000 (22:44 +0530)
committerjaskiratsingh <jaskirat.singh@partners.rivigo.com>
Tue, 2 Apr 2019 17:14:48 +0000 (22:44 +0530)
lib/sqlalchemy/engine/__init__.py
lib/sqlalchemy/pool/base.py

index a759d648ceb2fb3f9a415e8aacffe63e8646a09b..ac53fa637f522b33927dae4d2901b350e8facd4c 100644 (file)
@@ -170,10 +170,10 @@ def create_engine(*args, **kwargs):
         information on how to configure logging directly.
 
     :param echo_pool=False: if True, the connection pool will log
-        all checkouts/checkins to the logging stream, which defaults to
-        sys.stdout. This flag ultimately controls a Python logger; see
-        :ref:`dbengine_logging` for information on how to configure logging
-        directly.
+        all pool disconnects and whether reconnection attempts have exhausted 
+        or not to the logging stream, which defaults to sys.stdout. This flag 
+        ultimately controls a Python logger; see :ref:`dbengine_logging` for 
+        information on how to configure logging directly.
 
     :param empty_in_strategy:  The SQL compilation strategy to use when
         rendering an IN or NOT IN expression for :meth:`.ColumnOperators.in_`
index 31e13853655529f6db58ff2ced2f8a86312f8578..b0fdc82fbee5a4f74135186c15f4a442405a8f21 100644 (file)
@@ -105,10 +105,10 @@ class Pool(log.Identified):
           "sqlalchemy.pool" logger. Defaults to a hexstring of the object's
           id.
 
-        :param echo: If True, connections being pulled and retrieved
-          from the pool will be logged to the standard output, as well
-          as pool sizing information.  Echoing can also be achieved by
-          enabling logging for the "sqlalchemy.pool"
+        :param echo: if True, the connection pool will log
+          all pool disconnects and whether reconnection attempts have exhausted
+          or not to the logging stream, which defaults to sys.stdout. Echoing
+          can also be achieved by enabling logging for the "sqlalchemy.pool"
           namespace. Defaults to False.
 
         :param use_threadlocal: If set to True, repeated calls to