/opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm
Edit: /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyo (105293B)
4]c @@ sp d Z d d l m Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z d d l
m Z d d l m
Z
d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m! Z! d d l m" Z" d d l m# Z# d d l m$ Z$ d d l m% Z% d d l m& Z& d d! l m' Z' d" Z( d# Z) e j* e j+ j, d$ d% e- d& e f d' Y Z. d( Z/ d) e0 f d* YZ1 d+ e0 f d, YZ2 d S(- s Heuristics related to join conditions as used in
:func:`.relationship`.
Provides the :class:`.JoinCondition` object, which encapsulates
SQL annotation and aliasing behavior focused on the `primaryjoin`
and `secondaryjoin` aspects of :func:`.relationship`.
i ( t absolute_importNi ( t
attributes( t
dependency( t mapper( t state_str( t
MANYTOMANY( t MANYTOONE( t ONETOMANY( t PropComparator( t StrategizedProperty( t
_orm_annotate( t _orm_deannotate( t CascadeOptionsi ( t exc( t log( t schema( t sql( t util( t inspect( t
expression( t operators( t visitors( t _deep_deannotate( t _shallow_annotate( t adapt_criterion_to_null( t
ClauseAdapter( t join_condition( t selectables_overlap( t visit_binary_productc C@ s t t j | i t d 6 S( s Annotate a portion of a primaryjoin expression
with a 'remote' annotation.
See the section :ref:`relationship_custom_foreign` for a
description of use.
.. seealso::
:ref:`relationship_custom_foreign`
:func:`.foreign`
t remote( t _annotate_columnsR t _clause_element_as_exprt True( t expr( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR 3 s c C@ s t t j | i t d 6 S( s Annotate a portion of a primaryjoin expression
with a 'foreign' annotation.
See the section :ref:`relationship_custom_foreign` for a
description of use.
.. seealso::
:ref:`relationship_custom_foreign`
:func:`.remote`
t foreign( R R R R ( R! ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR" F s s sqlalchemy.orm.propertiest
add_to_allt RelationshipPropertyc " B@ s e Z d Z d Z e Z e j d d d f e e e e e e e e e e e e d e e e e e e e e e e e e e e e e e e e d Z
d Z d e f d YZ
e e d
Z e e e d Z d Z e e d
Z d Z d Z e j d Z e d Z d Z e j d Z e j d Z d Z d Z d Z d Z d Z d Z! e" e e! Z# d Z$ d Z% d Z& d Z' d Z( e j d Z) e j d! Z* e e e e e d" Z+ RS(# s Describes an object property that holds a single item or list
of items that correspond to a related database table.
Public constructor is the :func:`.orm.relationship` function.
.. seealso::
:ref:`relationship_config_toplevel`
t relationshipt extensions 0.7s :class:`.AttributeExtension` is deprecated in favor of the :class:`.AttributeEvents` listener interface. The :paramref:`.relationship.extension` parameter will be removed in a future release.t selectc" " C@ s t t | j | | _ | | _ | | _ | | _ | | _ |
| _ t | _
|
| _ | | _ | | _
| | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ |! | _ | | _ | | _ | | _ | | _ | pt j | _! | j! | t | _" t# j$ | | t k r[| | _% n d | j f f | _& t' | _( | t) k r| n d | _* | | _+ | | _, | j, r| rt- j. d n t | _/ n | | _/ d S( s} Provide a relationship between two mapped classes.
This corresponds to a parent-child or associative table relationship.
The constructed class is an instance of
:class:`.RelationshipProperty`.
A typical :func:`.relationship`, used in a classical mapping::
mapper(Parent, properties={
'children': relationship(Child)
})
Some arguments accepted by :func:`.relationship` optionally accept a
callable function, which when called produces the desired value.
The callable is invoked by the parent :class:`.Mapper` at "mapper
initialization" time, which happens only when mappers are first used,
and is assumed to be after all mappings have been constructed. This
can be used to resolve order-of-declaration and other dependency
issues, such as if ``Child`` is declared below ``Parent`` in the same
file::
mapper(Parent, properties={
"children":relationship(lambda: Child,
order_by=lambda: Child.id)
})
When using the :ref:`declarative_toplevel` extension, the Declarative
initializer allows string arguments to be passed to
:func:`.relationship`. These string arguments are converted into
callables that evaluate the string as Python code, using the
Declarative class-registry as a namespace. This allows the lookup of
related classes to be automatic via their string name, and removes the
need for related classes to be imported into the local module space
before the dependent classes have been declared. It is still required
that the modules in which these related classes appear are imported
anywhere in the application at some point before the related mappings
are actually used, else a lookup error will be raised when the
:func:`.relationship` attempts to resolve the string reference to the
related class. An example of a string- resolved class is as
follows::
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class Parent(Base):
__tablename__ = 'parent'
id = Column(Integer, primary_key=True)
children = relationship("Child", order_by="Child.id")
.. seealso::
:ref:`relationship_config_toplevel` - Full introductory and
reference documentation for :func:`.relationship`.
:ref:`orm_tutorial_relationship` - ORM tutorial introduction.
:param argument:
a mapped class, or actual :class:`.Mapper` instance, representing
the target of the relationship.
:paramref:`~.relationship.argument` may also be passed as a callable
function which is evaluated at mapper initialization time, and may
be passed as a Python-evaluable string when using Declarative.
.. seealso::
:ref:`declarative_configuring_relationships` - further detail
on relationship configuration when using Declarative.
:param secondary:
for a many-to-many relationship, specifies the intermediary
table, and is typically an instance of :class:`.Table`.
In less common circumstances, the argument may also be specified
as an :class:`.Alias` construct, or even a :class:`.Join` construct.
:paramref:`~.relationship.secondary` may
also be passed as a callable function which is evaluated at
mapper initialization time. When using Declarative, it may also
be a string argument noting the name of a :class:`.Table` that is
present in the :class:`.MetaData` collection associated with the
parent-mapped :class:`.Table`.
The :paramref:`~.relationship.secondary` keyword argument is
typically applied in the case where the intermediary :class:`.Table`
is not otherwise expressed in any direct class mapping. If the
"secondary" table is also explicitly mapped elsewhere (e.g. as in
:ref:`association_pattern`), one should consider applying the
:paramref:`~.relationship.viewonly` flag so that this
:func:`.relationship` is not used for persistence operations which
may conflict with those of the association object pattern.
.. seealso::
:ref:`relationships_many_to_many` - Reference example of "many
to many".
:ref:`orm_tutorial_many_to_many` - ORM tutorial introduction to
many-to-many relationships.
:ref:`self_referential_many_to_many` - Specifics on using
many-to-many in a self-referential case.
:ref:`declarative_many_to_many` - Additional options when using
Declarative.
:ref:`association_pattern` - an alternative to
:paramref:`~.relationship.secondary` when composing association
table relationships, allowing additional attributes to be
specified on the association table.
:ref:`composite_secondary_join` - a lesser-used pattern which
in some cases can enable complex :func:`.relationship` SQL
conditions to be used.
.. versionadded:: 0.9.2 :paramref:`~.relationship.secondary` works
more effectively when referring to a :class:`.Join` instance.
:param active_history=False:
When ``True``, indicates that the "previous" value for a
many-to-one reference should be loaded when replaced, if
not already loaded. Normally, history tracking logic for
simple many-to-ones only needs to be aware of the "new"
value in order to perform a flush. This flag is available
for applications that make use of
:func:`.attributes.get_history` which also need to know
the "previous" value of the attribute.
:param backref:
indicates the string name of a property to be placed on the related
mapper's class that will handle this relationship in the other
direction. The other property will be created automatically
when the mappers are configured. Can also be passed as a
:func:`.backref` object to control the configuration of the
new relationship.
.. seealso::
:ref:`relationships_backref` - Introductory documentation and
examples.
:paramref:`~.relationship.back_populates` - alternative form
of backref specification.
:func:`.backref` - allows control over :func:`.relationship`
configuration when using :paramref:`~.relationship.backref`.
:param back_populates:
Takes a string name and has the same meaning as
:paramref:`~.relationship.backref`, except the complementing
property is **not** created automatically, and instead must be
configured explicitly on the other mapper. The complementing
property should also indicate
:paramref:`~.relationship.back_populates` to this relationship to
ensure proper functioning.
.. seealso::
:ref:`relationships_backref` - Introductory documentation and
examples.
:paramref:`~.relationship.backref` - alternative form
of backref specification.
:param bake_queries=True:
Use the :class:`.BakedQuery` cache to cache the construction of SQL
used in lazy loads. True by default. Set to False if the
join condition of the relationship has unusual features that
might not respond well to statement caching.
.. versionchanged:: 1.2
"Baked" loading is the default implementation for the "select",
a.k.a. "lazy" loading strategy for relationships.
.. versionadded:: 1.0.0
.. seealso::
:ref:`baked_toplevel`
:param cascade:
a comma-separated list of cascade rules which determines how
Session operations should be "cascaded" from parent to child.
This defaults to ``False``, which means the default cascade
should be used - this default cascade is ``"save-update, merge"``.
The available cascades are ``save-update``, ``merge``,
``expunge``, ``delete``, ``delete-orphan``, and ``refresh-expire``.
An additional option, ``all`` indicates shorthand for
``"save-update, merge, refresh-expire,
expunge, delete"``, and is often used as in ``"all, delete-orphan"``
to indicate that related objects should follow along with the
parent object in all cases, and be deleted when de-associated.
.. seealso::
:ref:`unitofwork_cascades` - Full detail on each of the available
cascade options.
:ref:`tutorial_delete_cascade` - Tutorial example describing
a delete cascade.
:param cascade_backrefs=True:
a boolean value indicating if the ``save-update`` cascade should
operate along an assignment event intercepted by a backref.
When set to ``False``, the attribute managed by this relationship
will not cascade an incoming transient object into the session of a
persistent parent, if the event is received via backref.
.. seealso::
:ref:`backref_cascade` - Full discussion and examples on how
the :paramref:`~.relationship.cascade_backrefs` option is used.
:param collection_class:
a class or callable that returns a new list-holding object. will
be used in place of a plain list for storing elements.
.. seealso::
:ref:`custom_collections` - Introductory documentation and
examples.
:param comparator_factory:
a class which extends :class:`.RelationshipProperty.Comparator`
which provides custom SQL clause generation for comparison
operations.
.. seealso::
:class:`.PropComparator` - some detail on redefining comparators
at this level.
:ref:`custom_comparators` - Brief intro to this feature.
:param distinct_target_key=None:
Indicate if a "subquery" eager load should apply the DISTINCT
keyword to the innermost SELECT statement. When left as ``None``,
the DISTINCT keyword will be applied in those cases when the target
columns do not comprise the full primary key of the target table.
When set to ``True``, the DISTINCT keyword is applied to the
innermost SELECT unconditionally.
It may be desirable to set this flag to False when the DISTINCT is
reducing performance of the innermost subquery beyond that of what
duplicate innermost rows may be causing.
.. versionchanged:: 0.9.0 -
:paramref:`~.relationship.distinct_target_key` now defaults to
``None``, so that the feature enables itself automatically for
those cases where the innermost query targets a non-unique
key.
.. seealso::
:ref:`loading_toplevel` - includes an introduction to subquery
eager loading.
:param doc:
docstring which will be applied to the resulting descriptor.
:param extension:
an :class:`.AttributeExtension` instance, or list of extensions,
which will be prepended to the list of attribute listeners for
the resulting descriptor placed on the class.
:param foreign_keys:
a list of columns which are to be used as "foreign key"
columns, or columns which refer to the value in a remote
column, within the context of this :func:`.relationship`
object's :paramref:`~.relationship.primaryjoin` condition.
That is, if the :paramref:`~.relationship.primaryjoin`
condition of this :func:`.relationship` is ``a.id ==
b.a_id``, and the values in ``b.a_id`` are required to be
present in ``a.id``, then the "foreign key" column of this
:func:`.relationship` is ``b.a_id``.
In normal cases, the :paramref:`~.relationship.foreign_keys`
parameter is **not required.** :func:`.relationship` will
automatically determine which columns in the
:paramref:`~.relationship.primaryjoin` condition are to be
considered "foreign key" columns based on those
:class:`.Column` objects that specify :class:`.ForeignKey`,
or are otherwise listed as referencing columns in a
:class:`.ForeignKeyConstraint` construct.
:paramref:`~.relationship.foreign_keys` is only needed when:
1. There is more than one way to construct a join from the local
table to the remote table, as there are multiple foreign key
references present. Setting ``foreign_keys`` will limit the
:func:`.relationship` to consider just those columns specified
here as "foreign".
2. The :class:`.Table` being mapped does not actually have
:class:`.ForeignKey` or :class:`.ForeignKeyConstraint`
constructs present, often because the table
was reflected from a database that does not support foreign key
reflection (MySQL MyISAM).
3. The :paramref:`~.relationship.primaryjoin` argument is used to
construct a non-standard join condition, which makes use of
columns or expressions that do not normally refer to their
"parent" column, such as a join condition expressed by a
complex comparison using a SQL function.
The :func:`.relationship` construct will raise informative
error messages that suggest the use of the
:paramref:`~.relationship.foreign_keys` parameter when
presented with an ambiguous condition. In typical cases,
if :func:`.relationship` doesn't raise any exceptions, the
:paramref:`~.relationship.foreign_keys` parameter is usually
not needed.
:paramref:`~.relationship.foreign_keys` may also be passed as a
callable function which is evaluated at mapper initialization time,
and may be passed as a Python-evaluable string when using
Declarative.
.. seealso::
:ref:`relationship_foreign_keys`
:ref:`relationship_custom_foreign`
:func:`.foreign` - allows direct annotation of the "foreign"
columns within a :paramref:`~.relationship.primaryjoin` condition.
:param info: Optional data dictionary which will be populated into the
:attr:`.MapperProperty.info` attribute of this object.
:param innerjoin=False:
when ``True``, joined eager loads will use an inner join to join
against related tables instead of an outer join. The purpose
of this option is generally one of performance, as inner joins
generally perform better than outer joins.
This flag can be set to ``True`` when the relationship references an
object via many-to-one using local foreign keys that are not
nullable, or when the reference is one-to-one or a collection that
is guaranteed to have one or at least one entry.
The option supports the same "nested" and "unnested" options as
that of :paramref:`.joinedload.innerjoin`. See that flag
for details on nested / unnested behaviors.
.. seealso::
:paramref:`.joinedload.innerjoin` - the option as specified by
loader option, including detail on nesting behavior.
:ref:`what_kind_of_loading` - Discussion of some details of
various loader options.
:param join_depth:
when non-``None``, an integer value indicating how many levels
deep "eager" loaders should join on a self-referring or cyclical
relationship. The number counts how many times the same Mapper
shall be present in the loading condition along a particular join
branch. When left at its default of ``None``, eager loaders
will stop chaining when they encounter a the same target mapper
which is already higher up in the chain. This option applies
both to joined- and subquery- eager loaders.
.. seealso::
:ref:`self_referential_eager_loading` - Introductory documentation
and examples.
:param lazy='select': specifies
how the related items should be loaded. Default value is
``select``. Values include:
* ``select`` - items should be loaded lazily when the property is
first accessed, using a separate SELECT statement, or identity map
fetch for simple many-to-one references.
* ``immediate`` - items should be loaded as the parents are loaded,
using a separate SELECT statement, or identity map fetch for
simple many-to-one references.
* ``joined`` - items should be loaded "eagerly" in the same query as
that of the parent, using a JOIN or LEFT OUTER JOIN. Whether
the join is "outer" or not is determined by the
:paramref:`~.relationship.innerjoin` parameter.
* ``subquery`` - items should be loaded "eagerly" as the parents are
loaded, using one additional SQL statement, which issues a JOIN to
a subquery of the original statement, for each collection
requested.
* ``selectin`` - items should be loaded "eagerly" as the parents
are loaded, using one or more additional SQL statements, which
issues a JOIN to the immediate parent object, specifying primary
key identifiers using an IN clause.
.. versionadded:: 1.2
* ``noload`` - no loading should occur at any time. This is to
support "write-only" attributes, or attributes which are
populated in some manner specific to the application.
* ``raise`` - lazy loading is disallowed; accessing
the attribute, if its value were not already loaded via eager
loading, will raise an :exc:`~sqlalchemy.exc.InvalidRequestError`.
This strategy can be used when objects are to be detached from
their attached :class:`.Session` after they are loaded.
.. versionadded:: 1.1
* ``raise_on_sql`` - lazy loading that emits SQL is disallowed;
accessing the attribute, if its value were not already loaded via
eager loading, will raise an
:exc:`~sqlalchemy.exc.InvalidRequestError`, **if the lazy load
needs to emit SQL**. If the lazy load can pull the related value
from the identity map or determine that it should be None, the
value is loaded. This strategy can be used when objects will
remain associated with the attached :class:`.Session`, however
additional SELECT statements should be blocked.
.. versionadded:: 1.1
* ``dynamic`` - the attribute will return a pre-configured
:class:`.Query` object for all read
operations, onto which further filtering operations can be
applied before iterating the results. See
the section :ref:`dynamic_relationship` for more details.
* True - a synonym for 'select'
* False - a synonym for 'joined'
* None - a synonym for 'noload'
.. seealso::
:doc:`/orm/loading_relationships` - Full documentation on
relationship loader configuration.
:ref:`dynamic_relationship` - detail on the ``dynamic`` option.
:ref:`collections_noload_raiseload` - notes on "noload" and "raise"
:param load_on_pending=False:
Indicates loading behavior for transient or pending parent objects.
When set to ``True``, causes the lazy-loader to
issue a query for a parent object that is not persistent, meaning it
has never been flushed. This may take effect for a pending object
when autoflush is disabled, or for a transient object that has been
"attached" to a :class:`.Session` but is not part of its pending
collection.
The :paramref:`~.relationship.load_on_pending` flag does not improve
behavior when the ORM is used normally - object references should be
constructed at the object level, not at the foreign key level, so
that they are present in an ordinary way before a flush proceeds.
This flag is not not intended for general use.
.. seealso::
:meth:`.Session.enable_relationship_loading` - this method
establishes "load on pending" behavior for the whole object, and
also allows loading on objects that remain transient or
detached.
:param order_by:
indicates the ordering that should be applied when loading these
items. :paramref:`~.relationship.order_by` is expected to refer to
one of the :class:`.Column` objects to which the target class is
mapped, or the attribute itself bound to the target class which
refers to the column.
:paramref:`~.relationship.order_by` may also be passed as a callable
function which is evaluated at mapper initialization time, and may
be passed as a Python-evaluable string when using Declarative.
:param passive_deletes=False:
Indicates loading behavior during delete operations.
A value of True indicates that unloaded child items should not
be loaded during a delete operation on the parent. Normally,
when a parent item is deleted, all child items are loaded so
that they can either be marked as deleted, or have their
foreign key to the parent set to NULL. Marking this flag as
True usually implies an ON DELETE
rule is in
place which will handle updating/deleting child rows on the
database side.
Additionally, setting the flag to the string value 'all' will
disable the "nulling out" of the child foreign keys, when the parent
object is deleted and there is no delete or delete-orphan cascade
enabled. This is typically used when a triggering or error raise
scenario is in place on the database side. Note that the foreign
key attributes on in-session child objects will not be changed after
a flush occurs so this is a very special use-case setting.
Additionally, the "nulling out" will still occur if the child
object is de-associated with the parent.
.. seealso::
:ref:`passive_deletes` - Introductory documentation
and examples.
:param passive_updates=True:
Indicates the persistence behavior to take when a referenced
primary key value changes in place, indicating that the referencing
foreign key columns will also need their value changed.
When True, it is assumed that ``ON UPDATE CASCADE`` is configured on
the foreign key in the database, and that the database will
handle propagation of an UPDATE from a source column to
dependent rows. When False, the SQLAlchemy :func:`.relationship`
construct will attempt to emit its own UPDATE statements to
modify related targets. However note that SQLAlchemy **cannot**
emit an UPDATE for more than one level of cascade. Also,
setting this flag to False is not compatible in the case where
the database is in fact enforcing referential integrity, unless
those constraints are explicitly "deferred", if the target backend
supports it.
It is highly advised that an application which is employing
mutable primary keys keeps ``passive_updates`` set to True,
and instead uses the referential integrity features of the database
itself in order to handle the change efficiently and fully.
.. seealso::
:ref:`passive_updates` - Introductory documentation and
examples.
:paramref:`.mapper.passive_updates` - a similar flag which
takes effect for joined-table inheritance mappings.
:param post_update:
this indicates that the relationship should be handled by a
second UPDATE statement after an INSERT or before a
DELETE. Currently, it also will issue an UPDATE after the
instance was UPDATEd as well, although this technically should
be improved. This flag is used to handle saving bi-directional
dependencies between two individual rows (i.e. each row
references the other), where it would otherwise be impossible to
INSERT or DELETE both rows fully since one row exists before the
other. Use this flag when a particular mapping arrangement will
incur two rows that are dependent on each other, such as a table
that has a one-to-many relationship to a set of child rows, and
also has a column that references a single child row within that
list (i.e. both tables contain a foreign key to each other). If
a flush operation returns an error that a "cyclical
dependency" was detected, this is a cue that you might want to
use :paramref:`~.relationship.post_update` to "break" the cycle.
.. seealso::
:ref:`post_update` - Introductory documentation and examples.
:param primaryjoin:
a SQL expression that will be used as the primary
join of the child object against the parent object, or in a
many-to-many relationship the join of the parent object to the
association table. By default, this value is computed based on the
foreign key relationships of the parent and child tables (or
association table).
:paramref:`~.relationship.primaryjoin` may also be passed as a
callable function which is evaluated at mapper initialization time,
and may be passed as a Python-evaluable string when using
Declarative.
.. seealso::
:ref:`relationship_primaryjoin`
:param remote_side:
used for self-referential relationships, indicates the column or
list of columns that form the "remote side" of the relationship.
:paramref:`.relationship.remote_side` may also be passed as a
callable function which is evaluated at mapper initialization time,
and may be passed as a Python-evaluable string when using
Declarative.
.. seealso::
:ref:`self_referential` - in-depth explanation of how
:paramref:`~.relationship.remote_side`
is used to configure self-referential relationships.
:func:`.remote` - an annotation function that accomplishes the
same purpose as :paramref:`~.relationship.remote_side`, typically
when a custom :paramref:`~.relationship.primaryjoin` condition
is used.
:param query_class:
a :class:`.Query` subclass that will be used as the base of the
"appender query" returned by a "dynamic" relationship, that
is, a relationship that specifies ``lazy="dynamic"`` or was
otherwise constructed using the :func:`.orm.dynamic_loader`
function.
.. seealso::
:ref:`dynamic_relationship` - Introduction to "dynamic"
relationship loaders.
:param secondaryjoin:
a SQL expression that will be used as the join of
an association table to the child object. By default, this value is
computed based on the foreign key relationships of the association
and child tables.
:paramref:`~.relationship.secondaryjoin` may also be passed as a
callable function which is evaluated at mapper initialization time,
and may be passed as a Python-evaluable string when using
Declarative.
.. seealso::
:ref:`relationship_primaryjoin`
:param single_parent:
when True, installs a validator which will prevent objects
from being associated with more than one parent at a time.
This is used for many-to-one or many-to-many relationships that
should be treated either as one-to-one or one-to-many. Its usage
is optional, except for :func:`.relationship` constructs which
are many-to-one or many-to-many and also
specify the ``delete-orphan`` cascade option. The
:func:`.relationship` construct itself will raise an error
instructing when this option is required.
.. seealso::
:ref:`unitofwork_cascades` - includes detail on when the
:paramref:`~.relationship.single_parent` flag may be appropriate.
:param uselist:
a boolean that indicates if this property should be loaded as a
list or a scalar. In most cases, this value is determined
automatically by :func:`.relationship` at mapper configuration
time, based on the type and direction
of the relationship - one to many forms a list, many to one
forms a scalar, many to many is a list. If a scalar is desired
where normally a list would be present, such as a bi-directional
one-to-one relationship, set :paramref:`~.relationship.uselist` to
False.
The :paramref:`~.relationship.uselist` flag is also available on an
existing :func:`.relationship` construct as a read-only attribute,
which can be used to determine if this :func:`.relationship` deals
with collections or scalar attributes::
>>> User.addresses.property.uselist
True
.. seealso::
:ref:`relationships_one_to_one` - Introduction to the "one to
one" relationship pattern, which is typically when the
:paramref:`~.relationship.uselist` flag is needed.
:param viewonly=False:
when set to True, the relationship is used only for loading objects,
and not for any persistence operation. A :func:`.relationship`
which specifies :paramref:`~.relationship.viewonly` can work
with a wider range of SQL operations within the
:paramref:`~.relationship.primaryjoin` condition, including
operations that feature the use of a variety of comparison operators
as well as SQL functions such as :func:`~.sql.expression.cast`. The
:paramref:`~.relationship.viewonly` flag is also of general use when
defining any kind of :func:`~.relationship` that doesn't represent
the full set of related objects, to prevent modifications of the
collection from resulting in persistence operations.
:param omit_join:
Allows manual control over the "selectin" automatic join
optimization. Set to ``False`` to disable the "omit join" feature
added in SQLAlchemy 1.3.
.. versionadded:: 1.3
t lazys save-update, mergesC backref and back_populates keyword arguments are mutually exclusiveN(0 t superR$ t __init__t uselistt argumentt secondaryt primaryjoint
secondaryjoint post_updatet Nonet directiont viewonlyR( t
single_parentt _user_defined_foreign_keyst collection_classt passive_deletest cascade_backrefst passive_updatest remote_sidet enable_typecheckst query_classt innerjoint distinct_target_keyt doct active_historyt
join_deptht omit_joint local_remote_pairsR& t bake_queriest load_on_pendingt
Comparatort comparator_factoryt
comparatorR t set_creation_ordert infot strategy_keyt sett _reverse_propertyt Falset cascadet order_byt back_populatest sa_exct
ArgumentErrort backref(" t selfR, R- R. R/ t foreign_keysR+ RP RT RQ R0 RO R& R3 R( R6 R7 R9 R: R; RA RG R4 R= R> R? R@ R8 RE RD t _local_remote_pairsR< RJ RB ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR* l s^
c C@ s; t j | j | j d | j | | d | d | j d S( NRH t parententityR? ( R t register_descriptort class_t keyRG R? ( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt instrument_class s RF c B@ s e Z d Z d Z d d d Z d Z e j d Z e j d Z
e j d Z d Z d Z
d Z d Z d Z d
Z d d Z d d Z d d
Z d Z d Z d Z e j d Z RS( s Produce boolean, comparison, and other operators for
:class:`.RelationshipProperty` attributes.
See the documentation for :class:`.PropComparator` for a brief
overview of ORM level operator definition.
.. seealso::
:class:`.PropComparator`
:class:`.ColumnProperty.Comparator`
:class:`.ColumnOperators`
:ref:`types_operators`
:attr:`.TypeEngine.comparator_factory`
c C@ s1 | | _ | | _ | | _ | r- | | _ n d S( s Construction of :class:`.RelationshipProperty.Comparator`
is internal to the ORM's attribute mechanics.
N( t propt
_parententityt _adapt_to_entityt _of_type( RU R] t parentmappert adapt_to_entityt of_type( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR* s
c C@ s% | j | j | j d | d | j S( NRb Rc ( t __class__t propertyR^ R` ( RU Rb ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRb s
c C@ s
| j j S( s# The target entity referred to by this
:class:`.RelationshipProperty.Comparator`.
This is either a :class:`.Mapper` or :class:`.AliasedInsp`
object.
This is the "target" or "remote" side of the
:func:`.relationship`.
( Re t entity( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRf s c C@ s
| j j S( s The target :class:`.Mapper` referred to by this
:class:`.RelationshipProperty.Comparator`.
This is the "target" or "remote" side of the
:func:`.relationship`.
( Re R ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c C@ s
| j j S( N( Re t parent( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR^ s c C@ s$ | j r | j j S| j j j Sd S( N( R_ t
selectableRe Rg t _with_polymorphic_selectable( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _source_selectable s
c C@ s | j } | j r* t | j j } n d } | j j d | d t d | \ } } } } } } | d k rw | | @S| Sd S( Nt source_selectablet source_polymorphict of_type_mapper( Rj R` R R R1 Re t
_create_joinsR ( RU t
adapt_fromRm t pjt sjt sourcet destR- t target_adapter( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __clause_element__ s c C@ s% t j | j | j d | j d | S( s Redefine this object in terms of a polymorphic subclass.
See :meth:`.PropComparator.of_type` for an example.
Rb Rc ( R$ RF Re R^ R_ ( RU t cls( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRc s
c C@ s t d d S( s Produce an IN clause - this is not implemented
for :func:`~.orm.relationship`-based attributes at this time.
sv in_() not yet supported for relationships. For a simple many-to-one, use in_() against the set of foreign key values.N( t NotImplementedError( RU t other( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt in_ s c C@ s t | t j t j f r` | j j t t g k r> | j St
| j j d d | j
Sn= | j j r~ t j d n t
| j j | d | j
Sd S( s Implement the ``==`` operator.
In a many-to-one context, such as::
MyClass.some_prop ==
this will typically produce a
clause such as::
mytable.related_id ==
Where ```` is the primary key of the given
object.
The ``==`` operator provides partial functionality for non-
many-to-one comparisons:
* Comparisons against collections are not supported.
Use :meth:`~.RelationshipProperty.Comparator.contains`.
* Compared to a scalar one-to-many, will produce a
clause that compares the target columns in the parent to
the given target.
* Compared to a scalar many-to-many, an alias
of the association table will be rendered as
well, forming a natural join that is part of the
main body of the query. This will not work for
queries that go beyond simple AND conjunctions of
comparisons, such as those which use OR. Use
explicit joins, outerjoins, or
:meth:`~.RelationshipProperty.Comparator.has` for
more comprehensive non-many-to-one scalar
membership tests.
* Comparisons against ``None`` given in a one-to-many
or many-to-many context produce a NOT EXISTS clause.
t adapt_sources] Can't compare a collection to an object or collection; use contains() to test for membership.N( t
isinstanceR t NoneTypeR t NullRe R2 R R t _criterion_existsR
t _optimized_compareR1 t adapterR+ RR t InvalidRequestError( RU Rx ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __eq__ s % c K@ sJ t | d d r t | j } | j | j | j } } } | j j r` | r` | j } n | j
} | d k r | d k r | | @} q | } q n t } d } | j r | j
} n d } | j j d t d | d | \ } }
} } }
} xO | D]G } t | j j j | | | k } | d k r;| } q | | @} q W|
d k rht | |
@} n t | d | j j } | d k r| r| r| j | } n | d k r| j i t d 6 } n | t j j | @} |
d k r"t j d g | d | |
g j | |
} n$ t j d g | d | j | } | S( NR` t dest_polymorphict dest_selectableRk t excludet no_replacement_traversei t from_obj( t getattrR1 R R` R Rh t is_aliased_classRe t _is_self_referentialt aliast _single_table_criterionRN R Rj Rn R RZ R
R: t traverset _annotateR t True_t _ifnonet existst correlate_except( RU t criteriont kwargsRJ t
target_mappert
to_selectableR t single_critRk Rp Rq Rr Rs R- Rt t kt critt jt ex( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR~ I sX
" c K@ s. | j j s t j d n | j | | S( sm Produce an expression that tests a collection against
particular criterion, using EXISTS.
An expression like::
session.query(MyClass).filter(
MyClass.somereference.any(SomeRelated.x==2)
)
Will produce a query like::
SELECT * FROM my_table WHERE
EXISTS (SELECT 1 FROM related WHERE related.my_id=my_table.id
AND related.x=2)
Because :meth:`~.RelationshipProperty.Comparator.any` uses
a correlated subquery, its performance is not nearly as
good when compared against large target tables as that of
using a join.
:meth:`~.RelationshipProperty.Comparator.any` is particularly
useful for testing for empty collections::
session.query(MyClass).filter(
~MyClass.somereference.any()
)
will produce::
SELECT * FROM my_table WHERE
NOT EXISTS (SELECT 1 FROM related WHERE
related.my_id=my_table.id)
:meth:`~.RelationshipProperty.Comparator.any` is only
valid for collections, i.e. a :func:`.relationship`
that has ``uselist=True``. For scalar references,
use :meth:`~.RelationshipProperty.Comparator.has`.
s9 'any()' not implemented for scalar attributes. Use has().( Re R+ RR R R~ ( RU R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt any s ) c K@ s. | j j r t j d n | j | | S( s Produce an expression that tests a scalar reference against
particular criterion, using EXISTS.
An expression like::
session.query(MyClass).filter(
MyClass.somereference.has(SomeRelated.x==2)
)
Will produce a query like::
SELECT * FROM my_table WHERE
EXISTS (SELECT 1 FROM related WHERE
related.id==my_table.related_id AND related.x=2)
Because :meth:`~.RelationshipProperty.Comparator.has` uses
a correlated subquery, its performance is not nearly as
good when compared against large target tables as that of
using a join.
:meth:`~.RelationshipProperty.Comparator.has` is only
valid for scalar references, i.e. a :func:`.relationship`
that has ``uselist=False``. For collection references,
use :meth:`~.RelationshipProperty.Comparator.any`.
s4 'has()' not implemented for collections. Use any().( Re R+ RR R R~ ( RU R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt has s c K@ sd | j j s t j d n | j j | d | j } | j j d k r` | j | | _ n | S( sd Return a simple expression that tests a collection for
containment of a particular item.
:meth:`~.RelationshipProperty.Comparator.contains` is
only valid for a collection, i.e. a
:func:`~.orm.relationship` that implements
one-to-many or many-to-many with ``uselist=True``.
When used in a simple one-to-many context, an
expression like::
MyClass.contains(other)
Produces a clause like::
mytable.id ==
Where ```` is the value of the foreign key
attribute on ``other`` which refers to the primary
key of its parent object. From this it follows that
:meth:`~.RelationshipProperty.Comparator.contains` is
very useful when used with simple one-to-many
operations.
For many-to-many operations, the behavior of
:meth:`~.RelationshipProperty.Comparator.contains`
has more caveats. The association table will be
rendered in the statement, producing an "implicit"
join, that is, includes multiple tables in the FROM
clause which are equated in the WHERE clause::
query(MyClass).filter(MyClass.contains(other))
Produces a query like::
SELECT * FROM my_table, my_association_table AS
my_association_table_1 WHERE
my_table.id = my_association_table_1.parent_id
AND my_association_table_1.child_id =
Where ```` would be the primary key of
``other``. From the above, it is clear that
:meth:`~.RelationshipProperty.Comparator.contains`
will **not** work with many-to-many collections when
used in queries that move beyond simple AND
conjunctions, such as multiple
:meth:`~.RelationshipProperty.Comparator.contains`
expressions joined by OR. In such cases subqueries or
explicit "outer joins" will need to be used instead.
See :meth:`~.RelationshipProperty.Comparator.any` for
a less-performant alternative using EXISTS, or refer
to :meth:`.Query.outerjoin` as well as :ref:`ormtutorial_joins`
for more details on constructing outer joins.
s9 'contains' not implemented for scalar attributes. Use ==Rz N(
Re R+ RR R R R R/ R1 t' _Comparator__negated_contains_or_equalst negation_clause( RU Rx R t clause( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt contains s 8 c @ s
j j t k r t j | } f d } f d } j j r t j g j j D]H \ } } t j | | | | | | | k | | d k ^ q^ Sn t j g t j j j
j j j | D] \ } } | | k ^ q } j | S( Nc
@ s= | j } t j | d t d j j j j | | | S( Nt uniquet callable_( t dictR t bindparamR Re t _get_attr_w_warn_on_noneR ( t xt statet colt dict_( RU ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt state_bindparam< s c @ s j r j | S| Sd S( N( R ( R ( RU ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt adaptF s
( Re R2 R R t instance_statet _use_getR t and_RC t or_R1 t zipR t primary_keyt primary_key_from_instanceR~ ( RU Rx R R R R t yR ( ( RU sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __negated_contains_or_equals8 s
\ 7c C@ s t | t j t j f rZ | j j t k rM t | j j d d | j S| j Sn1 | j j
rx t j d n t | j | Sd S( s$ Implement the ``!=`` operator.
In a many-to-one context, such as::
MyClass.some_prop !=
This will typically produce a clause such as::
mytable.related_id !=
Where ```` is the primary key of the
given object.
The ``!=`` operator provides partial functionality for non-
many-to-one comparisons:
* Comparisons against collections are not supported.
Use
:meth:`~.RelationshipProperty.Comparator.contains`
in conjunction with :func:`~.expression.not_`.
* Compared to a scalar one-to-many, will produce a
clause that compares the target columns in the parent to
the given target.
* Compared to a scalar many-to-many, an alias
of the association table will be rendered as
well, forming a natural join that is part of the
main body of the query. This will not work for
queries that go beyond simple AND conjunctions of
comparisons, such as those which use OR. Use
explicit joins, outerjoins, or
:meth:`~.RelationshipProperty.Comparator.has` in
conjunction with :func:`~.expression.not_` for
more comprehensive non-many-to-one scalar
membership tests.
* Comparisons against ``None`` given in a one-to-many
or many-to-many context produce an EXISTS clause.
Rz s] Can't compare a collection to an object or collection; use contains() to test for membership.N( R{ R R| R R} Re R2 R R
R R1 R R~ R+ RR R R ( RU Rx ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __ne__d s '
c C@ s# t j j r t j j n | j S( N( t mapperlibt Mappert _new_mapperst _configure_allR] ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRe s N( t __name__t
__module__t __doc__R1 R` R* Rb R t memoized_propertyRf R R^ Rj Ru Rc Ry t __hash__R R~ R R R R R Re ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRF s(
: T 1 " H , :c C@ sX d } | d k r9 t | } | j r9 | j j } q9 n | j | d t d | d | S( Nt value_is_parentRz t alias_secondary( R1 R R t _adaptert adapt_clauseR R ( RU t instanceR t from_entityRz t insp( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _with_parent s c @ s5 d k r t j n | } d k rD j | d | S| sf j j j j } n j j j j } | r j n j
t j j f d } j
d k r | r t j
j j | } n t j | i i | d 6 } | r1| | } n | S( NRz c @ s8 | j k r4 j | j | _ n d S( N( t _identifying_keyR t callable( R ( t bind_to_colR R RU R ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt visit_bindparam s R ( R1 R R t _lazy_none_clauset _lazy_strategyt
_lazywheret _bind_to_colt _rev_lazywheret _rev_bind_to_colR Rg t
instance_dictt objR- R R R R t cloned_traverse( RU R R Rz R t reverse_directionR R ( ( R R R RU R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s0
c @ s> j j j f d } | S( sK Create the callable that is used in a many-to-one expression.
E.g.::
u1 = s.query(User).get(5)
expr = Address.user == u1
Above, the SQL should be "address.user_id = 5". The callable
returned by this method produces the value "5" based on the identity
of ``u1``.
c @ s j j } } | t j k } j d j rG t j n
t j t j A} | t j k r | s t
j d t f q n@ | t j
k r | s t
j d t f q n | } | d k r t j d n | S( Nt passivesU Can't resolve value for column %s on object %s; no value has been set for this columns` Can't resolve value for column %s on object %s; the object is detached and the value was expireds Got None for value of column %s; this is unsupported for a relationship comparison and will not currently produce an IS comparison (but may in a future release)( t _last_known_valuesR[ R t NO_VALUEt _get_state_attr_by_columnt
persistentt PASSIVE_OFFt PASSIVE_NO_FETCHt INIT_OKt NEVER_SETRR R R t PASSIVE_NO_RESULTR1 R t warn( t
last_knownt to_returnt existing_is_availablet
current_value( t columnR R R] R ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _go s0 ( t get_property_by_columnt _track_last_known_valueR[ ( RU R R R R R ( ( R R R R] R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s +*c C@ sc | s" | j j | j j } } n | j j | j j } } t | | } | r_ | | } n | S( N( R R R R R R ( RU R Rz R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR I s c C@ s t | j j j d | j S( Nt .( t strRg RZ R R[ ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __str__[ s c
C@ s\ | r3 x* | j D] } | | f | k r d Sq Wn d | j k rF d S| j | k rY d S| j r| j | j j | | }
t |
d r |
j }
n | r | j | j j | | n g } x| |
D]t } t j | }
t j
| } t | |
| f <| j |
| d | d | d | } | d k r | j | q q W| st j | | | j } xC | D] } | j | qjWqX| j | j j | | | d t n | | j } | d k rt j | }
t j
| } t | |
| f <| j |
| d | d | d | } n d } | s6| | | j y s c s@ s! | ] } t j | d Vq d S( R: N( R R, ( R- R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys ~ s N( RP R. R/ R- R5 R: ( R. R/ ( R R R t setattrR1 R R R, RP RN t to_listt
column_sett
to_column_setR5 R: Rf t persist_selectablet target( RU t attrt
attr_valuet valR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR# M s8
4 c ! C@ s t d | j j d | j j d | j j d | j j d | j d | j d | j d | j j d | j j d
| j
d | j d | j d
| j
d | d | j d | j | _ } | j | _ | j | _ | j | _ | j | _ | j | _ | j | _ | j | _ | j | _ | j | _ d S( Nt parent_persist_selectablet child_persist_selectablet parent_local_selectablet child_local_selectableR. R- R/ t parent_equivalentst child_equivalentst consider_as_foreign_keysRC R: t self_referentialR] t support_synct can_be_synced_fn( t
JoinConditionRg R2 Rf t local_tableR. R- R/ t _equivalent_columnsR R5 RC R: R R3 t _columns_are_mappedR( R2 t remote_columnst
local_columnst synchronize_pairst foreign_key_columnst _calculated_foreign_keyst secondary_synchronize_pairs( RU t jc( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR$ s4
c C@ sl | j j rh t j | j j d t j | j rh t j d | j | j j j
| j j j
f n d S( sO Test that this relationship is legal, warn about
inheritance conflicts.R s Attempting to assign a new relationship '%s' to a non-primary mapper on class '%s'. New relationships can only be added to the primary mapper, i.e. the very first mapper created for class '%s' N( Rg t non_primaryR R RZ RN t has_propertyR[ RR RS R ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR" s
c C@ s | j S( s\ Return the current cascade setting for this
:class:`.RelationshipProperty`.
( R ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _get_cascade s c C@ sP t | } d | j k r+ | j | n | | _ | j rL | | j _ n d S( NR ( R t __dict__R% R t _dependency_processorRO ( RU RO ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _set_cascade s c C@ s | j rG | j rG | j t k s1 | j t k rG t j d | n | j t k rs | j rs t j d | n | j d k r d | k s d | k r t j d | n | j r | j
j j j
| j | j j f n d S( Ns On %s, delete-orphan cascade is not supported on a many-to-many or many-to-one relationship when single_parent is not set. Set single_parent=True on the relationship().sl On %s, 'passive_deletes' is normally configured on one-to-many, one-to-one, many-to-many relationships only.t allR s
delete-orphans^ On %s, can't set passive_deletes='all' in conjunction with 'delete' or 'delete-orphan' cascade( t
delete_orphanR4 R2 R R RR RS R7 R R R t primary_mappert _delete_orphansR R[ Rg RZ ( RU RO ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR% s$
c C@ s& | j | j k o% | j | j | k S( sa Return True if this property will persist values on behalf
of the given mapper.
( R[ t
relationships( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt
_persists_for s c G@ sr xk | D]c } | j d k r7 | j j j | r7 q n | j j j j | r | j j j | r t Sq Wt S( s Return True if all columns in the given collection are
mapped by the tables referenced by this :class:`.Relationship`.
N( R- R1 R t contains_columnRg R2 R3 RN R ( RU t colsR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRD s
c
C@ s) | j j r d S| j d k r | j r t | j t j rQ | j i } } n | j \ } } | j j } | j
s t | j j
| j } xI | D]> } | j | r | j
r t j d | | | f q q Wn | j d k r$| j d | j j } | j d | j j } nB | j d | j j } | j d d } | rft j d n | j d | j } | j j } | j d | j | j d | j | j d | j | | _ t | | j | | d | d
| j | }
| j | |
n | j r%| j! | j n d S( sh Interpret the 'backref' instruction to create a
:func:`.relationship` complementary to this one.Ns] Error creating backref '%s' on relationship '%s': property of that name exists on mapper '%s'R. R/ sO Can't assign 'secondaryjoin' on a backref against a non-secondary relationship.RV R3 R0 R9 RQ (" Rg RL RT R1 RQ R{ R t string_typesR RT t concreteRL t iterate_to_roott uniont self_and_descendantsRM RR RS R- t popR( t secondaryjoin_minus_localt primaryjoin_minus_localt primaryjoin_reverse_remoteR R5 t
setdefaultR3 R0 R9 R$ R[ t _configure_propertyR ( RU t backref_keyR R t checkt mRp Rq RV Rg R% ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR' s^
c C@ sI | j d k r$ | j t k | _ n | j sE t j j | | _ n d S( N( R+ R1 R2 R R3 R t DependencyProcessort from_relationshipRP ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR& N s
c C@ s | j } | j S( sP memoize the 'use_get' attribute of this RelationshipLoader's
lazyloader.( R t use_get( RU t strategy( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR V s c C@ s | j j | j S( N( R R Rg ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR ^ s c
C@ s< | d k r0 | r0 | j j r0 | j j } q0 n t } | d k r | j j } | ri | j j ri t } n | j r | d k r | j
} t } q n t } | p | j } | j } | p | d k } | j j
| | | | \ } }
} } } | d k r | j j } n | d k r&| j j } n | |
| | | | f S( N( R1 Rg t with_polymorphicRi RN Rf Rh R R R R R R( t join_targetsRB (
RU Rl Rk R R Rm t aliasedt dest_mapperR R. R/ R- Rt ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRn b s6 ! (, R R R t strategy_wildcard_keyR1 RP R t deprecated_paramsRN R R* R\ R RF R R R R R R R R R R R R Rf R R* R# R$ R" RN RQ Re RO R% RW RD R' R& R R Rn ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR$ Z s 4 ^ X 7
7 L c @ s1 f d | d k r- | } n | S( Nc @ s> t | t j r* | j j } n | j d | S( Nt clone( R{ R t ColumnClauseR t copyt _copy_internals( t elem( t annotationsRr ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRr s ( R1 ( t elementRw ( ( Rw Rr sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s RA c
B@ s e Z d& d& d& d& d& d& d& d& e d& e d d Z d Z d Z d Z e d Z
e d Z e j
d Z d Z e j
d Z e j
d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d Z$ e% j& Z' d Z( e j
d Z) e j
d Z* e j
d! Z+ d" Z, d# Z- d& d$ Z. e d% Z/ RS(' c G@ s t S( N( R ( R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt t c C@ s0 | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ | | _ |
| _ | | _
| | _ | | _ |
| _
| | _ | | _ | j | j | j | j | j | j | j | j | j t | j d k r| j | j t n | j | j | j d S( N( R7 R9 R8 R: R; R< R. R/ R- R= RW t _remote_sideR] R> R? R@ t _determine_joinst _sanitize_joinst
_annotate_fkst _annotate_remotet _annotate_localt _annotate_parentmappert _setup_pairst _check_foreign_colsR R1 RN t _determine_directiont _check_remote_sidet
_log_joins( RU R7 R8 R9 R: R. R- R/ R; R< R= RC R: R> R] R? R@ ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR* s:
c C@ sP | j d k r d S| j j } | j d | j | j | j d | j | j | j d | j d j d | j D | j d | j d j d | j p g D | j d | j d j d | j D | j d
| j d j d | j
D | j d | j d j d
| j D | j d | j | j d S( Ns %s setup primary join %ss %s setup secondary join %ss %s synchronize pairs [%s]t ,c s@ s% | ] \ } } d | | f Vq d S( s
(%s => %s)N( ( R- t lR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s s# %s secondary synchronize pairs [%s]c s@ s% | ] \ } } d | | f Vq d S( s
(%s => %s)N( ( R- R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s s %s local/remote pairs [%s]c s@ s% | ] \ } } d | | f Vq d S( s (%s / %s)N( ( R- R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s s %s remote columns [%s]c s@ s | ] } d | Vq d S( s %sN( ( R- R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s s %s local columns [%s]c s@ s | ] } d | Vq d S( s %sN( ( R- R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s s %s relationship direction %s(
R] R1 t loggerRJ R. R/ t joinRG RJ RC RE RF R2 ( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s< c C@ sF t | j d d | _ | j d k rB t | j d d | _ n d S( sb remove the parententity annotation from our join conditions which
can leak in here based on some declarative patterns and maybe others.
We'd want to remove "parentmapper" also, but apparently there's
an exotic use case in _join_fixture_inh_selfref_w_entity
that relies upon it being present, see :ticket:`3364`.
t valuesRX N( RX ( RX ( R R. R/ R1 ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR} s
c C@ s | j d k r7 | j d k r7 t j d | j n y | j pF d } | j d k r | j d k r t | j | j d | j d | | _ n | j
d k rt | j | j d | j d | | _
qn9 | j
d k rt | j | j d | j d | | _
n Wn t j
k
rd| j d k rKt j
d | j | j f qt j
d | j n[ t j k
r| j d k rt j d | j | j f qt j d | j n Xd S( s Determine the 'primaryjoin' and 'secondaryjoin' attributes,
if not passed to the constructor already.
This is based on analysis of the foreign key relationships
between the parent and target mapped selectables.
sM Property %s specified with secondary join condition but no secondary argumentt a_subsetR= s1 Could not determine join condition between parent/child tables on relationship %s - there are no foreign keys linking these tables via secondary table '%s'. Ensure that referencing columns are associated with a ForeignKey or ForeignKeyConstraint, or specify 'primaryjoin' and 'secondaryjoin' expressions.s Could not determine join condition between parent/child tables on relationship %s - there are no foreign keys linking these tables. Ensure that referencing columns are associated with a ForeignKey or ForeignKeyConstraint, or specify a 'primaryjoin' expression.sl Could not determine join condition between parent/child tables on relationship %s - there are multiple foreign key paths linking the tables via secondary table '%s'. Specify the 'foreign_keys' argument, providing a list of those columns which should be counted as containing a foreign key reference from the secondary table to each of the parent and child tables.s' Could not determine join condition between parent/child tables on relationship %s - there are multiple foreign key paths linking the tables. Specify the 'foreign_keys' argument, providing a list of those columns which should be counted as containing a foreign key reference to the parent table.N( R/ R1 R- RR RS R] R= R R8 R: R. R7 R9 t NoForeignKeysErrort AmbiguousForeignKeysError( RU R= ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR| sR c C@ s t | j d d S( NR t localR ( R R ( R R. ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRa i s c C@ s t | j d d S( NR R R ( R R ( R R/ ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR` m s c C@ sU | j r( d } t j | j i | S| j rD t | j d d St | j Sd S( s( Return the primaryjoin condition suitable for the
"reverse" direction.
If the primaryjoin was delivered here with pre-existing
"remote" annotations, the local/remote annotations
are reversed. Otherwise, the local/remote annotations
are removed.
c S@ s| d | j k r< | j j } | d =t | d <| j | Sd | j k rx | j j } | d =t | d <| j | Sd S( NR R ( t _annotationsRt R t _with_annotations( Rx t v( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt replace~ s
R R R N( R R ( t _has_remote_annotationsR t replacement_traverseR. t _has_foreign_annotationsR ( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRb q s c C@ s8 x1 t j | i D] } | | j k r t Sq Wt Sd S( N( R t iterateR R RN ( RU R t
annotationR ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _has_annotation s c C@ s | j | j d S( NR" ( R R. ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c C@ s | j | j d S( NR ( R R. ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c C@ s1 | j r
d S| j r# | j n
| j d S( s Annotate the primaryjoin and secondaryjoin
structures with 'foreign' annotations marking columns
considered as foreign.
N( R R= t _annotate_from_fk_listt _annotate_present_fks( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR~ s
c @ s[ f d } t j j i | _ j d k rW t j j i | _ n d S( Nc @ s' | j k r# | j i t d 6 Sd S( NR" ( R= R R ( R ( RU ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt check_fk s ( R R R. R/ R1 ( RU R ( ( RU sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c @ s | j d k r' t j | j j n t f d f d } t j | j i i | d 6 | _ | j d k r t j | j i i | d 6 | _ n d S( Nc @ s t | t j rM t | t j rM | j | r7 | S| j | rM | Sn r | k ro | k ro | S| k r | k r | Sn d S( N( R{ R t Columnt
references( t at b( t
secondarycols( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt
is_foreign s $c @ s t | j t j s, t | j t j r0 d Sd | j j k r d | j j k r | j | j } | d k r | j | j r | j j i t d 6 | _ q | j | j r | j j i t d 6 | _ q q n d S( NR" (
R{ t leftR t
ColumnElementt rightR R1 t compareR R ( t binaryR ( R ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt visit_binary s R (
R- R1 R R0 R RL R R R. R/ ( RU R ( ( R R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s
c @ sU | j | j t g f d } t j | j i i | d 6 d S( sv Return True if the join condition contains column
comparisons where both columns are in both tables.
c @ s | j | j } } t | t j r t | t j r j | j r j | j r j | j r j | j r t d | r>t | _ qt j d | j n: | rit | _ n( | r{t | _ n t j d | j d S( s[ Determine if this relationship is one to many, many to one,
many to many.
R R" sD Can't determine relationship direction for relationship '%s' - foreign key columns within the join condition are present in both the parent and the child's mapped tables. Ensure that only those columns referring to a parent column are marked as foreign, either via the foreign() annotation or via the foreign_keys argument.s Can't determine relationship direction for relationship '%s' - foreign key columns are present in neither the parent nor the child's mapped tablesN( R/ R1 R R2 R R0 R7 R R8 t intersectionRH R R. RL R RE RF t
differenceR R RR RS R] ( RU t
parentcolst
targetcolst onetomany_fkt manytoone_fkt onetomany_localR t manytoone_localt self_equated( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR ) sB
c C@ s/ g | D]$ \ } } | j | j f ^ q S( s provide deannotation for the various lists of
pairs, so that using them in hashes doesn't incur
high-overhead __eq__() comparisons against
original columns mapped.
( t _deannotate( RU t
collectionR R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt _deannotate_pairs} s c @ s g } t j g g } f d } xK j | f j | f g D]+ \ } } | d k rj qL n | | | qL W j _ j | _ j | _ d S( Nc @ s& f d } t | | d S( Nc @ s d | j k rC d | j k rC j | rC j | | f nC d | j k r d | j k r j | r j | | f n | j t j k r j | | r d | j k r j | | f q d | j k r j | | f q n d S( NR R" ( R R@ R t operatorR t eqR ( R R R ( R t lrpRU ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s ( R ( t joincondR R ( R RU ( R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt go s ( R t
OrderedSetR. R/ R1 R RC RG RJ ( RU t
sync_pairst secondary_sync_pairsR R R ( ( R RU sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c @ s | j s
d Sxg | j D] \ } | f ^ q g | j D] \ } | f ^ q? D]O\ } t j d k r q\ n | j k r t j i | | j 6 | j s ( R? RG RJ t lenRV t _track_overlapping_sync_targetst weakreft WeakKeyDictionaryR] t itemsR R t _mapper_registryRW Rg RM R R R R ( RU t from_t other_propst prop_to_fromR R ( ( R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR) s8 %3#
c C@ s
| j d S( NR ( t _gather_join_annotations( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRE s c C@ s
| j d S( NR ( R ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRF s c C@ s
| j d S( NR" ( R ( RU ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRH s c C@ sW t | j | j | } | j d k rI | j | j | j | n d | D S( Nc S@ s h | ] } | j q S( ( R ( R- R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pys s ( RL R R. R/ R1 t update( RU R t s( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s c G@ sG t | } t g t j | i D] } | j | j r" | ^ q" S( N( RL R R t issubsetR ( RU R R R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s
c C@ s t | i t d 6 } | j | j | j } } } | d k re | d k rX | | @} qe | | @} n | r}| d k r | j d t } t | } t | d | j j | } | d k r t | j t | d | j
} n | j | } n^ t | d t d d | j } | d k rP| j t | d t d d | j
n d } | j | } | pn| }
d |
_
n d }
| | | |
| f S( s7 Given a source and destination selectable, create a
join between them.
This takes into account aliasing the join clause
to reference the appropriate corresponding columns
in the target objects, as well as the extra child
criterion, equivalent column sets, etc.
R t flatt equivalentst
exclude_fnR R N( R R R. R/ R- R1 R R R< t chainR; R t _ColInAnnotationsR ( RU Rk R Rn R R. R/ R- t primary_aliasizert secondary_aliasizerRt ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRm sT
c @ s t j t j } | j d k rz t j t x | j D]- \ } } | j | | f | | | s ( R t column_dictR/ R1 t collectionst defaultdictt listRC R R. R R R R ( RU R t equated_columnsR R R t lazywhereR/ R ( ( R R R R sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt create_lazy_clauseg s4 N(0 R R R1 RN R R* R R} R| Re Ra R` R R Rb R R R R~ R R R R R R R R R R R R R R R R R R R R R R) RE RF RH R R Rm R ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyRA sb ( [#
. /
B T + @ QR c B@ s e Z d Z d Z d Z RS( sK Seralizable equivalent to:
lambda c: "name" in c._annotations
c C@ s
| | _ d S( N( t name( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR* s c C@ s | j | j k S( N( R R ( RU R ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt __call__ s ( R R R R* R ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyR s (3 R t
__future__R R R Rz R R R R t baseR t
interfacesR R R R R R R
R R R
RR R R R t
inspectionR R R R t sql.utilR R R R R R R R R" t class_loggert langhelperst dependency_forR R$ R t objectRA R ( ( ( sO /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/relationships.pyt sd B