From cbe99b06679e2d2da1312f7d69b41f63bda1b41f Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Tue, 4 Oct 2016 12:01:12 -0400 Subject: [PATCH] - add a note to baked documentation indicating it is not really of general use. This extension is there only for those who really want it based on observed performance characteristics. Change-Id: I2f612f26fdef4ddbeb1158ab1b344fad7083b11c --- doc/build/orm/extensions/baked.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/build/orm/extensions/baked.rst b/doc/build/orm/extensions/baked.rst index 1dd875a864..0fb8da5dfe 100644 --- a/doc/build/orm/extensions/baked.rst +++ b/doc/build/orm/extensions/baked.rst @@ -25,9 +25,12 @@ the caching of the SQL calls and result sets themselves is available in .. note:: - The :mod:`sqlalchemy.ext.baked` extension should be considered - **experimental** as of 1.0.0. It provides a dramatically different system - of producing queries which has yet to be proven at scale. + The :mod:`sqlalchemy.ext.baked` extension is **not for beginners**. Using + it correctly requires a good high level understanding of how SQLAlchemy, the + database driver, and the backend database interact with each other. This + extension presents a very specific kind of optimization that is not ordinarily + needed. As noted above, it **does not cache queries**, only the string + formulation of the SQL itself. Synopsis -------- -- 2.47.2