From c7f9aa281857eeeaf7963c370bda43d2eb4746f5 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Thu, 19 Nov 2015 14:23:08 -0500 Subject: - rewrite the docs and add a test for the bake_queries=True relationship flag; this flag *does* have an effect when the baked lazy loader plugin has been invoked. clarify the intent of this flag as an "opt out" but only has an effect when the baked system is loaded anyway. fixes #3572 --- doc/build/orm/extensions/baked.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc') diff --git a/doc/build/orm/extensions/baked.rst b/doc/build/orm/extensions/baked.rst index a282d1298..83cee51da 100644 --- a/doc/build/orm/extensions/baked.rst +++ b/doc/build/orm/extensions/baked.rst @@ -355,6 +355,14 @@ this feature is local to the mapper for ``MyClass``. For per-query use, the :func:`.baked_lazyload` strategy may be used, which works like any other loader option. +Opting out with the bake_queries flag +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :func:`.relationship` construct includes a flag +:paramref:`.relationship.bake_queries` which when set to False will cause +that relationship to opt out of the baked query system, when the +application-wide :func:`.bake_lazy_loaders` function has been called to enable +baked query loaders by default. API Documentation ----------------- -- cgit v1.2.1