summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-08-22 14:52:50 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-08-22 14:52:50 -0400
commitb7378da077367c8eaa877362322fe08e3de59f0f (patch)
tree0b42806ed95efa9ef2d483d270afee888a6fbdcf
parent680baea6b83c497e862f3f0ade28e11940cfd895 (diff)
downloadsqlalchemy-b7378da077367c8eaa877362322fe08e3de59f0f.tar.gz
update enable_baked_queries flag doc
this flag is not relevant for ORM internals anymore and is overall legacy. Change-Id: I58ef7870881ff00b88d552af5eae6af11be6026c
-rw-r--r--lib/sqlalchemy/orm/session.py18
1 files changed, 7 insertions, 11 deletions
diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py
index 8302f70d6..fdef99370 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`,