diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-11-19 14:23:08 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-11-19 14:23:08 -0500 |
| commit | c7f9aa281857eeeaf7963c370bda43d2eb4746f5 (patch) | |
| tree | 8d99cb282312028f5004eae86a64f6004921b7dd /doc/build | |
| parent | 14498364f82eadaf3de914d5ac588cd5b9563547 (diff) | |
| download | sqlalchemy-c7f9aa281857eeeaf7963c370bda43d2eb4746f5.tar.gz | |
- 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
Diffstat (limited to 'doc/build')
| -rw-r--r-- | doc/build/orm/extensions/baked.rst | 8 |
1 files changed, 8 insertions, 0 deletions
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 ----------------- |