diff options
Diffstat (limited to 'doc/build/orm/loading_columns.rst')
| -rw-r--r-- | doc/build/orm/loading_columns.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/build/orm/loading_columns.rst b/doc/build/orm/loading_columns.rst index a0759e768..9566d0efc 100644 --- a/doc/build/orm/loading_columns.rst +++ b/doc/build/orm/loading_columns.rst @@ -1,3 +1,5 @@ +.. _loading_columns: + .. currentmodule:: sqlalchemy.orm =============== @@ -277,11 +279,9 @@ Column Deferral API Column Bundles ============== -The :class:`.Bundle` may be used to query for groups of columns under one +The :class:`_orm.Bundle` may be used to query for groups of columns under one namespace. -.. versionadded:: 0.9.0 - The bundle allows columns to be grouped together:: from sqlalchemy.orm import Bundle @@ -292,7 +292,7 @@ The bundle allows columns to be grouped together:: The bundle can be subclassed to provide custom behaviors when results are fetched. The method :meth:`.Bundle.create_row_processor` is given -the :class:`_query.Query` and a set of "row processor" functions at query execution +the statement object and a set of "row processor" functions at query execution time; these processor functions when given a result row will return the individual attribute value, which can then be adapted into any kind of return data structure. Below illustrates replacing the usual :class:`.Row` @@ -309,6 +309,11 @@ return structure with a straight Python dictionary:: ) return proc +.. note:: + + The :class:`_orm.Bundle` construct only applies to column expressions. + It does not apply to ORM attributes mapped using :func:`_orm.relationship`. + .. versionchanged:: 1.0 The ``proc()`` callable passed to the ``create_row_processor()`` |