From: Mike Bayer Date: Sun, 22 Aug 2021 18:52:50 +0000 (-0400) Subject: update enable_baked_queries flag doc X-Git-Tag: rel_1_4_24~65 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b7378da077367c8eaa877362322fe08e3de59f0f;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git update enable_baked_queries flag doc this flag is not relevant for ORM internals anymore and is overall legacy. Change-Id: I58ef7870881ff00b88d552af5eae6af11be6026c --- diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index 8302f70d6b..fdef993704 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -1049,17 +1049,13 @@ class Session(_SessionClassMethods): :param enable_baked_queries: defaults to ``True``. A flag consumed by the :mod:`sqlalchemy.ext.baked` extension to determine if "baked queries" should be cached, as is the normal operation - of this extension. When set to ``False``, all caching is disabled, - including baked queries defined by the calling application as - well as those used internally. Setting this flag to ``False`` - can significantly reduce memory use, however will also degrade - performance for those areas that make use of baked queries - (such as relationship loaders). Additionally, baked query - logic in the calling application or potentially within the ORM - that may be malfunctioning due to cache key collisions or similar - can be flagged by observing if this flag resolves the issue. - - .. versionadded:: 1.2 + of this extension. When set to ``False``, caching as used by + this particular extension is disabled. + + .. versionchanged:: 1.4 The ``sqlalchemy.ext.baked`` extension is + legacy and is not used by any of SQLAlchemy's internals. This + flag therefore only affects applications that are making explicit + use of this extension within their own code. :param expire_on_commit: Defaults to ``True``. When ``True``, all instances will be fully expired after each :meth:`~.commit`,