From: jaskiratsingh Date: Tue, 2 Apr 2019 17:21:59 +0000 (+0530) Subject: Documentation bugs fixed X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=907b3d2c01e921f637edcd1b45b12f31d6d51714;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Documentation bugs fixed --- diff --git a/doc/build/core/engines.rst b/doc/build/core/engines.rst index a22b7f22b3..438ddba8df 100644 --- a/doc/build/core/engines.rst +++ b/doc/build/core/engines.rst @@ -275,7 +275,7 @@ namespace of SA loggers that can be turned on is as follows: * ``sqlalchemy.engine`` - controls SQL echoing. set to ``logging.INFO`` for SQL query output, ``logging.DEBUG`` for query + result set output. * ``sqlalchemy.dialects`` - controls custom logging for SQL dialects. See the documentation of individual dialects for details. -* ``sqlalchemy.pool`` - controls connection pool logging. set to ``logging.INFO`` or lower to log connection pool checkouts/checkins. +* ``sqlalchemy.pool`` - controls connection pool logging. set to ``logging.DEBUG`` or lower to log connection pool checkouts/checkins. * ``sqlalchemy.orm`` - controls logging of various ORM functions. set to ``logging.INFO`` for information on mapper configurations. For example, to log SQL queries using Python logging instead of the ``echo=True`` flag:: diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py index a759d648ce..ac53fa637f 100644 --- a/lib/sqlalchemy/engine/__init__.py +++ b/lib/sqlalchemy/engine/__init__.py @@ -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_` diff --git a/lib/sqlalchemy/pool/base.py b/lib/sqlalchemy/pool/base.py index ea73f08d44..7bab2e532d 100644 --- a/lib/sqlalchemy/pool/base.py +++ b/lib/sqlalchemy/pool/base.py @@ -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