From: Mike Bayer Date: Wed, 16 May 2018 19:47:50 +0000 (-0400) Subject: Clarify dogpile.cache differences which occur via #4128. X-Git-Tag: rel_1_3_0b1~185 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b9f428a589a1718efa20e5555be45ae3f767e89e;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Clarify dogpile.cache differences which occur via #4128. The fix for :ticket:`4128` which failed to be included in the 1.2.5 release also works around an issue in the dogpile.cache "advanced" example, which will also be fixed independently. Change-Id: I5eb0da9b93f13f05a8cbe4559e2ed177b1f91a52 --- diff --git a/doc/build/changelog/unreleased_12/4128.rst b/doc/build/changelog/unreleased_12/4128.rst index 908bd115e1..f9cfe1373e 100644 --- a/doc/build/changelog/unreleased_12/4128.rst +++ b/doc/build/changelog/unreleased_12/4128.rst @@ -10,7 +10,17 @@ on the wiki. Note however that the :meth:`.Query.populate_existing` method is now required in order to rewrite the mapper options associated with an object - already loaded in the identity map. Also, a custom defined + already loaded in the identity map. + + As part of this change, a custom defined :class:`.MapperOption` will now cause lazy loaders related to the target object to use a non-baked query by default unless the :meth:`.MapperOption._generate_cache_key` method is implemented. + In particular, this repairs one regression which occured when + using the dogpile.cache "advanced" example, which was not + returning cached results and instead emitting SQL due to an + incompatibility with the baked query loader; with the change, + the ``RelationshipCache`` option included for many releases + in the dogpile example will disable the "baked" query altogether. + Note that the dogpile example is also modernized to avoid both + of these issues as part of issue :ticket:`4258`.