sqlalchemy.orm.properties.CompositeProperty.CompositeBundle

class documentation

class CompositeBundle(orm_util.Bundle):

View In Hierarchy

Undocumented

Method __init__ Construct a new .Bundle.
Method create​_row​_processor Produce the "row processing" function for this .Bundle.
Instance Variable property Undocumented

Inherited from Bundle:

Method __clause​_element__ Undocumented
Method ​_clone Undocumented
Method ​_gen​_cache​_key return an optional cache key.
Method label Provide a copy of this .Bundle passing a new label.
Class Variable ​_propagate​_attrs Undocumented
Class Variable is​_aliased​_class True if this object is an instance of .AliasedClass.
Class Variable is​_bundle True if this object is an instance of .Bundle.
Class Variable is​_clause​_element True if this object is an instance of _expression.ClauseElement.
Class Variable is​_mapper True if this object is an instance of _orm.Mapper.
Instance Variable ​_label Undocumented
Instance Variable c An alias for .Bundle.columns.
Instance Variable columns A namespace of SQL expressions referred to by this .Bundle.
Instance Variable exprs Undocumented
Instance Variable name Undocumented
Instance Variable single​_entity If True, queries for a single Bundle will be returned as a single entity, rather than an element within a keyed tuple.
Property clauses Undocumented
Property entity Undocumented
Property entity​_namespace Undocumented
Property mapper Undocumented

Inherited from ORMColumnsClauseRole (via Bundle):

Class Variable ​_role​_name Undocumented

Inherited from ColumnsClauseRole (via Bundle, ORMColumnsClauseRole):

Property ​_select​_iterable Undocumented

Inherited from AllowsLambdaRole (via Bundle, ORMColumnsClauseRole, ColumnsClauseRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via Bundle, ORMColumnsClauseRole, ColumnsClauseRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via Bundle, ORMColumnsClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SupportsCloneAnnotations (via Bundle):

Method ​_annotate return a copy of this ClauseElement with annotations updated by the given dictionary.
Method ​_deannotate return a copy of this _expression.ClauseElement with annotations removed.
Method ​_with​_annotations return a copy of this ClauseElement with annotations replaced by the given dictionary.
Class Variable ​_clone​_annotations​_traverse​_internals Undocumented

Inherited from SupportsAnnotations (via Bundle, SupportsCloneAnnotations):

Property ​_annotations​_cache​_key Undocumented

Inherited from MemoizedHasCacheKey (via Bundle):

Method ​_generate​_cache​_key return a cache key.

Inherited from HasCacheKey (via Bundle, MemoizedHasCacheKey):

Class Variable inherit​_cache Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.
Class Method ​_generate​_cache​_attrs generate cache key dispatcher for a new class.
Class Method ​_generate​_cache​_key​_for​_object Undocumented
Class Variable __slots__ Undocumented
Class Variable ​_hierarchy​_supports​_caching private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable ​_is​_has​_cache​_key Undocumented

Inherited from InspectionAttr (via Bundle):

Class Variable __slots__ Undocumented
Class Variable ​_is​_internal​_proxy True if this object is an internal proxy object.
Class Variable is​_attribute True if this object is a Python :term:`descriptor`.
Class Variable is​_instance True if this object is an instance of .InstanceState.
Class Variable is​_property True if this object is an instance of .MapperProperty.
Class Variable is​_selectable Return True if this object is an instance of _expression.Selectable.
def __init__(self, property_, expr):
overrides sqlalchemy.orm.util.Bundle.__init__

Construct a new .Bundle.

e.g.:

bn = Bundle("mybundle", MyClass.x, MyClass.y)

for row in session.query(bn).filter(
        bn.c.x == 5).filter(bn.c.y == 4):
    print(row.mybundle.x, row.mybundle.y)
Parameters
property​_Undocumented
exprUndocumented
namename of the bundle.
*exprscolumns or SQL expressions comprising the bundle.
single_entity=​Falseif True, rows for this .Bundle can be returned as a "single entity" outside of any enclosing tuple in the same manner as a mapped entity.
def create_row_processor(self, query, procs, labels):
overrides sqlalchemy.orm.util.Bundle.create_row_processor

Produce the "row processing" function for this .Bundle.

May be overridden by subclasses.

See Also

:ref:`bundles` - includes an example of subclassing.

property =

Undocumented