From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Tue, 10 Jul 2018 17:30:05 +0000 (-0400)
Subject: Document sticky behavior of loader options
X-Git-Tag: rel_1_3_0b1~135
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3cc832992d6820a3cbc88d1b8aca958af8175a49;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Document sticky behavior of loader options

References #4301

Change-Id: If921e3b8369e2cd5312b5964a99bcf7731b3ecfc
---

diff --git a/doc/build/orm/loading_relationships.rst b/doc/build/orm/loading_relationships.rst
index f3ee78b129..3699133169 100644
--- a/doc/build/orm/loading_relationships.rst
+++ b/doc/build/orm/loading_relationships.rst
@@ -148,6 +148,40 @@ of a particular attribute, the :func:`.defaultload` method/function may be used:
         defaultload("atob").
         joinedload("btoc")).all()
 
+.. note::  The loader options applied to an object's lazy-loaded collections
+   are **"sticky"** to specific object instances, meaning they will persist
+   upon collections loaded by that specific object for as long as it exists in
+   memory.  For example, given the previous example::
+
+      session.query(Parent).options(
+          lazyload(Parent.children).
+          subqueryload(Child.subelements)).all()
+
+   if the ``children`` collection on a particular ``Parent`` object loaded by
+   the above query is expired (such as when a :class:`.Session` object's
+   transaction is committed or rolled back, or :meth:`.Session.expire_all` is
+   used), when the ``Parent.children`` collection is next accessed in order to
+   re-load it, the ``Child.subelements`` collection will again be loaded using
+   subquery eager loading.This stays the case even if the above ``Parent``
+   object is accessed from a subsequent query that specifies a different set of
+   options.To change the options on an existing object without expunging it and
+   re-loading, they must be set explicitly in conjunction with the
+   :meth:`.Query.populate_existing` method::
+
+      # change the options on Parent objects that were already loaded
+      session.query(Parent).populate_existing().options(
+          lazyload(Parent.children).
+          lazyload(Child.subelements)).all()
+
+   If the objects loaded above are fully cleared from the :class:`.Session`,
+   such as due to garbage collection or that :meth:`.Session.expunge_all`
+   were used, the "sticky" options will also be gone and the newly created
+   objects will make use of new options if loaded again.
+
+   A future SQLAlchemy release may add more alternatives to manipulating
+   the loader options on already-loaded objects.
+
+
 .. _lazy_loading:
 
 Lazy Loading