[Jc @ s d Z d d k l Z d d k l Z d d k l Z l Z l Z l Z d d k l
Z d d k l
Z
d d k l Z d d k l Z l Z l Z d d k l Z l Z l Z l Z l Z d d k l Z l Z l Z l Z l Z l Z l Z l Z l! Z" d
d d g Z# e Z$ d
Z% d
e& f d YZ' d e& f d YZ( d e( f d YZ) d e( f d YZ* e i+ e' d e& f d YZ, d e i- f d YZ. d a/ e i0 i1 Z2 d Z3 d S( s The Query class and support.
Defines the :class:`~sqlalchemy.orm.query.Query` class, the central construct used by
the ORM to construct database queries.
The ``Query`` class should not be confused with the
:class:`~sqlalchemy.sql.expression.Select` class, which defines database SELECT
operations at the SQL (non-ORM) level. ``Query`` differs from ``Select`` in
that it returns ORM-mapped objects and interacts with an ORM session, whereas
the ``Select`` construct interacts directly with the database to return
iterable result sets.
i( t chain( t
itemgetter( t sqlt utilt logt schema( t exc( R ( t
expressiont visitorst operators( t
attributest
interfacest mappert
object_mappert evaluator( t AliasedClasst
ORMAdaptert _entity_descriptort _entity_infot _is_aliased_classt _is_mapped_classt _orm_columnst _orm_selectablet joint Queryt QueryContextt aliasedc s t i f d } | S( s Mark a method as generative.c sI | d i } x D] } | | | i q W| | | d | | S( Ni i ( t _clonet func_name( t fnt argst kwt selft assertion( t
assertions( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt generate/ s ( R t decorator( R" R# ( ( R" s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _generative, s c B sc e Z d Z dd d Z dd d Z d Z d Z d Z d Z d Z
d Z d Z d
Z
d Z e d Z d
Z d Z d Z d Z e d Z d Z d Z dd d Z dd d Z d Z d Z d Z d Z d Z d Z dd dd dd dd d Z! d Z" e d Z# d Z$ d Z% e d! Z& e d" Z' e d# Z( e d$ Z) e e dd dd d% Z* e d& Z+ d' Z, e- e. i/ d( d) Z0 e d* Z1 e d+ Z2 e d, Z3 dd d- Z4 e dd d. Z5 d/ Z6 e6 Z7 e d0 Z8 d1 Z9 e9 Z: d2 Z; e d3 Z< d4 Z= d5 Z> e d6 Z? e d7 Z@ e d8 ZA e e e d9 ZB d: ZC e e e e. iD d; d< d= ZE e e e e. iD d; d< d> ZF e e e d? ZG d@ ZH dA ZI dB ZJ dC ZK dD ZL dE ZM e. iD d; d< dF ZN e. iD d; d< dG ZO e e e dH ZP e e dI ZQ e e dJ ZR dK ZS e e dL ZT e e dM ZU e e dN ZV e e dO ZW dP ZX e e dQ ZY dR ZZ dS Z[ dT Z\ dU Z] dV Z^ dd dW Z_ e. i/ e_ Z` dd dd dd dd dd dX Za e dY Zb e dZ Zc d[ Zd dd ee d\ Zf d] d^ Zg d_ d` Zh ei da Zj db Zk dc Zl RS(e s@ Encapsulates the object-fetching operations provided by Mappers.c C s% | | _ g | _ d | _ t | _ t | _ t | _ d | _ d | _ d | _
h | _ d | _ d | _
t | _ d | _ t | _ t | _ d | _ d | _ t | _ t | _ t | _ h | _ d | _ d | _ d | _ d | _ h | _ d | _ d | _ t | _! | i" | d S( N( ( (# t sessiont
_with_optionst Nonet _lockmodet Falset _order_byt _group_byt _distinctt _offsett _limitt
_statementt _paramst
_yield_pert
_criteriont sett
_correlatet
_joinpointt _with_labelst Truet _enable_eagerloadst _Query__joinable_tablest _havingt _populate_existingt _version_checkt
_autoflusht _attributest
_current_patht _only_load_propst _refresh_statet _from_objt _polymorphic_adapterst _filter_aliasest _from_obj_aliast _Query__currenttablest
_set_entities( R t entitiesR& ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __init__; s> c C s[ | d j o
t } n g | _ x$ t i | D] } | | | q0 W| i | i d S( N( R( t _QueryEntityt _entitiesR t to_listt _Query__setup_aliasizers( R RI t entity_wrappert ent( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRH ] s
c
C s' t | d o | i i | _ } n h | _ } x | D] } x | i D] } | | j o t | \ } } } | o< | i o2 | i } | i | t i | | i
d } n1 | o t i | | i
} d } n d } } | | | | | f | | Wd S( Nt _mapper_adapter_map(
t hasattrRQ t copyRI R t with_polymorphict _with_polymorphic_mapperst) _Query__mapper_loads_polymorphically_witht sql_utilt
ColumnAdaptert _equivalent_columnsR( t setup_entity(
R RI t dRP t entityR t
selectablet is_aliased_classRT t adapter( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __setup_aliasizersf s&
c C sZ xS | i D]H } | | i | | i p4 | i p* | i d j p | i d j p
| i o t i d | n d | _ d | _ | _ t | _
| _ | _ h | _ d S( Ns< Query.%s() being called on a Query with existing criterion. ( (
R3 R0 RC R/ R( R. R, R R R* R+ R- t _Query__joined_tables( R t meth( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __no_criterion_condition s
c C s2 | i o t i d | n | i | d S( Ns< Query.%s() being called on a Query with existing criterion. ( R+ R R t _Query__no_criterion_condition( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __no_clauseelement_condition s
c C s% | i o t i d | n d S( Ns[ Query.%s() being called on a Query with an existing full statement - can't apply criterion.( R0 R R ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __no_statement_condition s
c C sA | i d j p | i d j o t i d | | f n d S( Ns Query.%s() being called on a Query which already has LIMIT or OFFSET applied. To modify the row-limited results of a Query, call from_self() first. Otherwise, call %s() before limit() or offset() are applied.( R/ R( R. R R ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __no_limit_offset! s c C sZ | o
| | _ n | o
| | _ n | o
| | _ n | o t | | _ n | S( N( R< R= RB R4 RA ( R t populate_existingt
version_checkt only_load_propst
refresh_state( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt
__get_options) s
c C s. | i } | i | } | i i | _ | S( N( t __class__t __new__t __dict__RS ( R t clst q( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR 4 s c C s& | i d | i i i h t d 6 S( s4 The full SELECT statement represented by this Query.t labelsRz ( t _compile_contextR7 t statementt _annotateR8 ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR : s c C s | i t i i S( s return the full SELECT statement represented by this Query, embedded within an Alias.
Eager JOIN generation within the query is disabled.
( t enable_eagerloadsR* R Ri ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt subquery@ s c C s | i t i S( N( R R* R ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __clause_element__H s c C s
| | _ d S( sZ Control whether or not eager joins are rendered.
When set to False, the returned Query will not render
eager joins regardless of eagerload() options
or mapper-level lazy=False configurations.
This is used primarily when nesting the Query's
statement into a subquery or other
selectable.
N( R9 ( R t value( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR K s
c C s
t | _ d S( s Apply column labels to the return value of Query.statement.
Indicates that this Query's `statement` accessor should return
a SELECT statement that applies labels to all columns in the
form _; this is commonly used to
disambiguate columns from multiple tables which have the same
name.
When the `Query` actually issues SQL to load rows, it always
uses column labeling.
N( R8 R7 ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt with_labelsZ s c C s | i S( s# The WHERE criterion for this Query.( R3 ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt whereclausej s c C s
| | _ d S( s indicate that this query applies to objects loaded within a certain path.
Used by deferred loaders (see strategies.py) which transfer query
options from an originating query to a newly generated query intended
for the deferred load.
N( R@ ( R t path( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _with_current_patho s c C s, | i } | i | | d | d | d S( s Load columns for descendant mappers of this Query's mapper.
Using this method will ensure that each descendant mapper's
tables are included in the FROM clause, and will allow filter()
criterion to be used against those tables. The resulting
instances will also have those columns already loaded so that
no "post fetch" of those columns will be required.
:param cls_or_mappers: a single class or mapper, or list of class/mappers,
which inherit from this Query's mapper. Alternatively, it
may also be the string ``'*'``, in which case all descending
mappers will be added to the FROM clause.
:param selectable: a table or select() statement that will
be used in place of the generated FROM clause. This argument
is required if any of the desired mappers use concrete table
inheritance, since SQLAlchemy currently cannot generate UNIONs
among tables automatically. If used, the ``selectable``
argument must represent the full set of tables and columns mapped
by every desired mapper. Otherwise, the unaccounted mapped columns
will result in their table being appended directly to the FROM
clause which will usually lead to incorrect results.
:param discriminator: a column to be used as the "discriminator"
column for the given selectable. If not given, the polymorphic_on
attribute of the mapper will be used, if any. This is useful
for mappers that don't have polymorphic loading behavior by default,
such as concrete table mappers.
R] t
discriminatorN( R t set_with_polymorphic( R t cls_or_mappersR] R R\ ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRT z s c C s
| | _ d S( s Yield only ``count`` rows at a time.
WARNING: use this method with caution; if the same instance is present
in more than one batch of rows, end-user changes to attributes will be
overwritten.
In particular, it's usually impossible to use this setting with
eagerly loaded collections (i.e. any lazy=False) since those
collections will be cleared for a new load when encountered in a
subsequent result batch.
N( R2 ( R t count( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt yield_per s c C sH t | d o | i } n | i d i | } | i | | S( s Return an instance of the object based on the given identifier, or None if not found.
The `ident` argument is a scalar or tuple of primary key column values
in the order of the table def's primary key columns.
t __composite_values__s5 get() can only be used against a single mapped class.( RR R R t identity_key_from_primary_keyt _get( R t identt key( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRu s sI Deprecated. Use sqlalchemy.orm.with_parent in conjunction with filter().c K s[ t | } | i | d t } | i } | i t i | d t } t | | i | S( s< Return a new Query with criterion corresponding to a parent instance.
Return a newly constructed Query object, with criterion corresponding
to a relationship to the given parent instance.
instance
a persistent or detached instance which is related to class
represented by this query.
property
string name of the property which relates this query's class to the
instance.
\**kwargs
all extra keyword arguments are propagated to the constructor of
Query.
t resolve_synonymst value_is_parent( R
t get_propertyR8 R t compareR t eqR t filter( R t instancet propertyt kwargsR t propt targett criterion( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt query_from_parent s
c G s# | i i d | D | _ d S( Nc s s x | ] } t | Vq Wd S( N( R ( t .0t s( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pys s ( R5 t union( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt correlate s c C s
| | _ d S( s% Return a Query with a specific 'autoflush' setting.
Note that a Session with autoflush=False will
not autoflush, even if this flag is set to True at the
Query level. Therefore this flag is usually used only
to disable autoflush for a specific Query.
N( R> ( R t setting( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt autoflush s
c C s
t | _ d S( s Return a Query that will refresh all instances loaded.
This includes all entities accessed from the database, including
secondary entities, eagerly-loaded collection items.
All changes present on entities which are already present in the
session will be reset and the entities will all be marked "clean".
An alternative to populate_existing() is to expire the Session
fully using session.expire_all().
N( R8 R< ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c C s d d k l } t | } | d j oq x | i D]4 } t | | i o | i | i j o Pq3 q3 Wt i
d | i i i | i
i f n | i | d t } | i | i t i | d t S( sJ Add a join criterion corresponding to a relationship to the given
parent instance.
instance
a persistent or detached instance which is related to class
represented by this query.
property
string name of the property which relates this query's class to the
instance. if None, the method will attempt to find a suitable
property.
Currently, this method only works with immediate parent relationships,
but in the future may be enhanced to work across a chain of parent
mappers.
i( t
propertiess\ Could not locate a property which relates instances of class '%s' to instances of class '%s'R R N( t sqlalchemy.ormR R
R( t iterate_propertiesRg t PropertyLoaderR R R R t class_t __name__R R R8 R R R R ( R R R R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt with_parent s
) /c C sO | o t | | } n t | i | _ t | | } | i | g d S( sA add a mapped entity to the list of result columns to be returned.N( R t listRL t
_MapperEntityRN ( R R\ Ri Re ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt
add_entity s
c G sL | i i t i i d } | i | } | o | i | n | S( s return a Query that selects from this Query's SELECT statement.
\*entities - optional list of entities which will replace
those being selected.
N( R R R* R R R( t _from_selectableRH ( R RI t
fromclauseR ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt from_self! s
!c C sH d | _ | _ t | _ | _ | _ d | _ | _ | i | d S( N(
R( R0 R3 R* R+ R, R- R/ R. t _Query__set_select_from( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR 0 s c G sR | p t d S| i } | i | d t | i p
d | _ n t | S( sT Return an iterator yielding result tuples corresponding to the given list of columnsRO i
( ( t iterR RH t
_ColumnEntityR2 ( R t columnsR ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt values7 s
c C s6 y | i | i d SWn t j
o d SXd S( sD Return a scalar result corresponding to the given column expression.i N( R t nextt
StopIterationR( ( R t column( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR C s c C sF t | i | _ t | i } t | | | i | i | d S( sE Add a SQL ColumnElement to the list of result columns to be returned.N( R RL R R RN ( R R t l( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt
add_columnJ s
c G s | i t | S( sV Return a new Query object, applying the given list of
MapperOptions.
( t _Query__optionsR* ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt optionsU s c G s | i t | S( N( R R8 ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _conditional_options\ s c G s | i i | _ g } t i | D]
} | | q& ~ } | i | | _ | o" x= | D] } | i | qZ Wn x | D] } | i | q| Wd S( N( R? RS R t flatten_iteratorR' t process_query_conditionallyt
process_query( R t conditionalR t _[1]t ot optst opt( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __options_ s * c C s
| | _ d S( s: Return a new Query object with the specified locking mode.N( R) ( R t mode( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt
with_lockmodem s c O st t | d j o | i | d n' t | d j o t i d n | i i | _ | i i | d S( s| add values for bind parameters which may have been specified in filter().
parameters may be specified using \**kwargs, or optionally a single dictionary
as the first positional argument. The reason for both is that \**kwargs is
convenient, however some parameter dictionaries contain unicode keys in which case
\**kwargs cannot be used.
i i sF params() takes zero or one positional argument, which is a dictionary.N( R R R t
ArgumentErrorR1 RS ( R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt paramss s
c C s t | t o t i | } n | d j o' t | t i o t i d n | i | t t } | i
d j o | i
| @| _
n
| | _
d S( s apply the given filtering criterion to the query and return the newly resulting ``Query``
the criterion is any sql.ClauseElement applicable to the WHERE clause of a select.
sH filter() argument must be of type sqlalchemy.sql.ClauseElement or stringN( Rg t
basestringR t textR( t
ClauseElementR R R R8 R3 ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s !c K s\ g } | i D], \ } } | t | i | d | j q ~ } | i t i | S( sZ apply the given filtering criterion to the query and return the newly resulting ``Query``.i ( t iteritemsR R R R t and_( R R R R R t clauses( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt filter_by s ?t list_deprecationt pendingc G s t | d j o | d d j o
d | _ nw g } | D]% } | | i t i | t t q< ~ } | i t j p | i d j o
| | _ n | i | | _ d S( sZ apply one or more ORDER BY criterion to the query and return the newly resulting ``Query``i i N( R R( R+ R R t _literal_as_textR8 R* ( R R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt order_by s $
9
c G s t t g } | D] } | t | q ~ } g } | D]% } | | i t i | t t q> ~ } | i t j o
| | _ n | i | | _ d S( sZ apply one or more GROUP BY criterion to the query and return the newly resulting ``Query``N( R R R R R R
R8 R, R* ( R R R t ct _[2]R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt group_by s
39
c C s t | t o t i | } n | d j o' t | t i o t i d n | i | t t } | i
d j o | i
| @| _
n
| | _
d S( sO apply a HAVING criterion to the query and return the newly resulting ``Query``.sH having() argument must be of type sqlalchemy.sql.ClauseElement or stringN( Rg R R R R( R R R R R8 R; ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt having s !c G s# | i t i | g t | S( s Produce a UNION of this Query against one or more queries.
e.g.::
q1 = sess.query(SomeClass).filter(SomeClass.foo=='bar')
q2 = sess.query(SomeClass).filter(SomeClass.bar=='foo')
q3 = q1.union(q2)
The method accepts multiple Query objects so as to control
the level of nesting. A series of ``union()`` calls such as::
x.union(y).union(z).all()
will nest on each ``union()``, and produces::
SELECT * FROM (SELECT * FROM (SELECT * FROM X UNION SELECT * FROM y) UNION SELECT * FROM Z)
Whereas::
x.union(y, z).all()
produces::
SELECT * FROM (SELECT * FROM X UNION SELECT * FROM y UNION SELECT * FROM Z)
( R R R R ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c G s# | i t i | g t | S( s Produce a UNION ALL of this Query against one or more queries.
Works the same way as :meth:`~sqlalchemy.orm.query.Query.union`. See that
method for usage examples.
( R R t union_allR ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c G s# | i t i | g t | S( s Produce an INTERSECT of this Query against one or more queries.
Works the same way as :meth:`~sqlalchemy.orm.query.Query.union`. See that
method for usage examples.
( R R t intersectR ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c G s# | i t i | g t | S( s Produce an INTERSECT ALL of this Query against one or more queries.
Works the same way as :meth:`~sqlalchemy.orm.query.Query.union`. See that
method for usage examples.
( R R t
intersect_allR ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c G s# | i t i | g t | S( s Produce an EXCEPT of this Query against one or more queries.
Works the same way as :meth:`~sqlalchemy.orm.query.Query.union`. See that
method for usage examples.
( R R t except_R ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c G s# | i t i | g t | S( s Produce an EXCEPT ALL of this Query against one or more queries.
Works the same way as :meth:`~sqlalchemy.orm.query.Query.union`. See that
method for usage examples.
( R R t
except_allR ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s c O sn | i d t | i d t } } | o# t d d i | i n | i | d t d | d | S( ss
Create a join against this ``Query`` object's criterion
and apply generatively, returning the newly resulting ``Query``.
Each element in \*props may be:
* a string property name, i.e. "rooms". This will join along the
relation of the same name from this Query's "primary" mapper, if
one is present.
* a class-mapped attribute, i.e. Houses.rooms. This will create a
join from "Houses" table to that of the "rooms" relation.
* a 2-tuple containing a target class or selectable, and an "ON"
clause. The ON clause can be the property name/ attribute like
above, or a SQL expression.
e.g.::
# join along string attribute names
session.query(Company).join('employees')
session.query(Company).join('employees', 'tasks')
# join the Person entity to an alias of itself,
# along the "friends" relation
PAlias = aliased(Person)
session.query(Person).join((Palias, Person.friends))
# join from Houses to the "rooms" attribute on the
# "Colonials" subclass of Houses, then join to the
# "closets" relation on Room
session.query(Houses).join(Colonials.rooms, Room.closets)
# join from Company entities to the "employees" collection,
# using "people JOIN engineers" as the target. Then join
# to the "computers" collection on the Engineer entity.
session.query(Company).join((people.join(engineers), 'employees'), Engineer.computers)
# join from Articles to Keywords, using the "keywords" attribute.
# assume this is a many-to-many relation.
session.query(Article).join(Article.keywords)
# same thing, but spelled out entirely explicitly
# including the association table.
session.query(Article).join(
(article_keywords, Articles.id==article_keywords.c.article_id),
(Keyword, Keyword.id==article_keywords.c.keyword_id)
)
\**kwargs include:
aliased - when joining, create anonymous aliases of each table. This is
used for self-referential joins or multiple joins to the same table.
Consider usage of the aliased(SomeClass) construct as a more explicit
approach to this.
from_joinpoint - when joins are specified using string property names,
locate the property from the mapper found in the most recent previous
join() call, instead of from the root entity.
R t from_joinpoints unknown arguments: %st ,t outerjoint create_aliases( Rp R* t TypeErrorR t iterkeyst _Query__join( R t propsR R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR % s >%#c O sn | i d t | i d t } } | o# t d d i | i n | i | d t d | d | S( s Create a left outer join against this ``Query`` object's criterion
and apply generatively, retunring the newly resulting ``Query``.
Usage is the same as the ``join()`` method.
R R s unknown arguments: %sR R R ( Rp R* R R R R R8 ( R R R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR h s %#c C s[ t | i | _ | i i | _ | p | i n d } } d } xt i | D]} t } t }
| } d } }
} } t | t
o | \ } } n d } t | t i t
f o | } | } n6 t | t i t
f o | } | } n
| } | } t | t i od t | d d }
| i } | } | p
| i } n |
o
|
} n
| i } | p
| } qnr t | t
oJ | p | i } n t | | \ } } | i } | p
| } qn | p | i } n | oO | i oE t | \ } } } t i | i | \ } } | p
| } qFn | p6 x3 | i D]$ } | i | o | i } PqWqWWn | p' t | t i o | i } qn | p t i d n | o t | t i o
| } n t | \ } } } | d j o; | d j o. | i | o t i d | | f n | o | o
| } n | o| o| | j ou | i! | i" p& t i d | i# | i" i# f n t | t$ i% p | i& } n t' | | } t( }
q| o t' | } t( }
q| i) p t | i" t$ i* o t' | } t( }
t( } q| o | i+ | i j oA | i, d j o* | i, | i j o t i d | qY qY n | i, o | i i- | i, n | i i- | i+ |
o
|
} q| i } qn |
o" t. | d | i/ d | i0 } n t | t$ i1 o3 |
o | i2 | } n | i3 | t t( } n | p( | | j p | i4 o | | i d j } t5 | | | d | d
| } |
o7 | | _0 | o# | i6 | t. | d | i/ qqY qY W| d j o, t7 | i } | | | >> session.query(Item).scalar()
-
>>> session.query(Item.id).scalar()
1
>>> session.query(Item.id).filter(Item.id < 0).scalar()
None
>>> session.query(Item.id, Item.name).scalar()
1
>>> session.query(func.count(Parent.id)).scalar()
20
This results in an execution of the underlying query.
i N( R Rg R& t
IndexErrorR( ( R RV ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt scalar s c C sK | i } t | i _ | i o | i o | i i n | i | S( N( R R8 R t
use_labelsR> R< R& t _execute_and_instances( R t context( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __iter__ s
c C s: | i i | i d | i d | i } | i | | S( NR R ( R& t executeR R1 R t instances( R t querycontextt result( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR_ s *c # s# | i } | d j o t | n t _ t t | i } | o t | i d j } | o! | o
d } q t
i } n d } | o d | i d i j } t
g } | i D] } | | i | | q ~ \ }
} | pG t d t | D } t i t d t f | } | i | _ n xt oh _ h _ | i o" | i | i }
|
p Pqn
| i }
| o/ g } x |
D] |
d | qWnt | o2 g } |
D] | |
d q~ } n; g } |
D]& | | f d |
D q~ } | o | | } n i oP | i oF i i j o3 i i i i | i i i i n | i i x3 i i D]" \ } \ } } | i | | qWx | D] VqW| i p PqDqDWd S( s
Given a ResultProxy cursor as returned by connection.execute(), return an ORM result as an iterator.
e.g.::
result = engine.execute("select * from users")
for u in session.query(User).instances(result):
print u
i c S s t i | t i S( ( R t unique_listt IdentitySet( t x( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt ( s t
append_resulti c s s< x5 | ]. \ } } | o | t t | f Vq q Wd S( N( R R ( R t it label( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pys 3 s t RowTuplec 3 s" x | ] } | Vq Wd S( N( ( R t proc( R` t row( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pys K s N(! R& R( R t
_new_runidt runidt boolR R R RL R Rf R t zipt
row_processort dictt enumeratet typeR R& R3 R8 t progresst partialsR2 t fetchmanyt fetchallR RA t commitRp t _finalize_loadedt items( R t cursort _Query__contextR& t filteredt
single_entityR t custom_rowsR t query_entityt processR t rowtuplet fetcht rowsR t _[3]t iit dict_t attrs( ( Ro R` s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRc sf
?
23'
c C s | p | i } | i o | o | i i o | d j o yj | i i | } t i | } | i o9 y | Wq t
i j
o | i i | d SXn | SWq t
j
o q Xn | d j o | d j o | d } q n t i | } | d j o | i } | i d n
| i } | d j o | i } h }
| i \ } } | i | t t } | | _ xu t | i D]d \ }
} y | |
|
| | i s R R R R i (# R) R< R t always_refreshR( R& t identity_mapR
t instance_statet expiredRX t ObjectDeletedErrort _remove_newly_deletedt KeyErrorR RM R R t _get_clauseR R8 R* R3 Rv t primary_keyR R\ R R R R1 t _Query__get_optionsRr R+ RS ( R R R R t lockmodeR R t stateR R R R t _get_paramsRk R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR a s` 1
)
c C sD h | i d 6| i d 6| i d 6| i p d d 6| i p d d 6S( NRP RQ RR R R ( R/ R. R- R, R( R; ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _select_args s
c C sE | i } | i d d j p& | i d d j p | i d t S( NRP RQ RR ( R Ru R( R* ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _should_nest_selectable s c st | i g f d } | i t i d t i i d t g } | i D] } | | | qJ ~ d d S( sI Apply this query's criterion to a SELECT COUNT statement.
If column expressions or LIMIT/OFFSET/DISTINCT are present,
the query "SELECT count(1) FROM (SELECT ...)" is issued,
so that the result matches the total number of rows
this query would return. For mapped entities,
the primary key columns of each is written to the
columns clause of the nested SELECT statement.
For a Query which is only against mapped entities,
a simpler "SELECT count(1) FROM table1, table2, ...
WHERE criterion" is issued.
c s3 t | t o | i i St d <| i g Sd S( Ni ( Rg R R R R8 R ( RP ( t should_nest( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt ent_cols s
t 1t nested_colsR i ( R t _col_aggregateR t literal_columnt funcR R RL ( R R R RP ( ( R s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s
0c
C sj t | } x! | i D] } | i | | q W| i o t | i } n
| i } | i | | i } | o | p
| g } n
t | } t i | | d | d t
| i } | i } t i | | i
| p | g i | } n( t i | | g | d | | i } | i o | i o | i i n | i i | d | i d | i S( NRl R^ R R ( R RL t
setup_contextt from_clauseR t fromst _adjust_for_single_inheritanceR R t selectR8 R Ri t corresponding_columnRF R> R< R& R] R1 R (
R t colR R R R` R\ Rl R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s(
$ 5'R c
C s | t d d g j o t i d n | i t } | i } t | i i d j p t | i i d t i
o t i d n | i i d } | i } | d j oE y" t i
} | i | i } Wq t i j
o
d } q Xn t i | | i } | d j o7 | i i | i } | i | d | i i } n | i o | i n | i | d | i }
| d j o | i i } g } | i i D]: \ \ }
} } t |
| o | | o | | qq~ } x | D] } | i t i | qWnu | d j og | i } xX | D]L } | i! t" | } | | i j o! | i t i | i | q@q@Wn x' | i# D] } | i$ | | | |
qW|
i% S( sZ Perform a bulk delete query.
Deletes rows matched by this query from the database.
:param synchronize_session: chooses the strategy for the removal of matched
objects from the session. Valid values are:
False
don't synchronize the session. This option is the most efficient and is reliable
once the session is expired, which typically occurs after a commit(). Before
the expiration, objects may still remain in the session which were in fact deleted
which can lead to confusing results if they are accessed via get() or already
loaded collections.
'fetch'
performs a select query before the delete to find objects that are matched
by the delete query and need to be removed from the session. Matched objects
are removed from the session. 'fetch' is the default strategy.
'evaluate'
experimental feature. Tries to evaluate the querys criteria in Python
straight on the objects in the session. If evaluation of the criteria isn't
implemented, the 'fetch' strategy will be used as a fallback.
The expression evaluator currently doesn't account for differing string
collations between the database and Python.
Returns the number of rows deleted, excluding any cascades.
The method does *not* offer in-Python cascading of relations - it is assumed that
ON DELETE CASCADE is configured for any foreign key references which require it.
The Session needs to be expired (occurs automatically after commit(), or call expire_all())
in order for the state of dependent objects subject to delete or delete-orphan cascade to be
correctly represented.
Also, the ``before_delete()`` and ``after_delete()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension`
methods are not called from this method. For a delete hook here, use the
``after_bulk_delete()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension` method.
t evaluateR sN Valid strategies for session synchronization are False, 'evaluate' and 'fetch'i i s= Only deletion via a single table query is currently supportedR (& R* R R R R R R R Rg R t TableR& R t EvaluatorCompilerR R t UnevaluatableErrorR t deletet with_only_columnsR Rb R1 R{ R> R R R R t
issubclassR R
R R R t
extensionst after_bulk_deletet rowcount( R t synchronize_sessionR` t
primary_tableR& t evaluator_compilert eval_conditiont delete_stmtt select_stmtt matched_rowsRe t
target_clsR R t pkt objt objs_to_expunget
target_mapperR t identity_keyt ext( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR sN , 7
"
&1
)
t expirec
C ss | t d d g j o t i d n | i t } | i } t | i i d j p t | i i d t i
o t i d n | i i d } | i } | d j o yp t i
} | i | i } h } xE | i D]7 \ } }
t i | } | i t i |
| |
R R R R R3 R R
R t
instance_dictt
unmodifiedt intersectionR| R t expire_attributesR4 t
differenceR R R t after_bulk_updateR ( R R R R` R R& R R t value_evaluatorsR R t update_stmtR R Re R R R R t evaluated_keysR R t to_evaluateR R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR D sd . 7
$
"
(
)
c C s t | } | i o | S| i o] y- h d d 6t d 6d d 6t d 6| i } Wq t j
o t i d | i q Xn t } x! | i D] } | i
| | q W| i i } | i
o t | i
} n
| i } | i | | i p0 | i o t i d q(t i d n | o| i o| i o= t t g } | i D] } | t i | qW~ } n d | _ g } t i | i | | i d | d | d
t d | i | i }
| i o |
i | i }
n |
i }
| i } t i! |
| | _" t i |
g | i# d | d | } |
}
x& | D] } t i$ |
| | i% }
qKW| i& |
| i o | i' | i" i( | i n | i' | i) n| i p
d | _ n | i* oV | i oL t t g } | i D] } | t i | q~ } | i | 7_ n | | i i 7} t i | i | i# | i d | d | d | d
t d | i | i } | i o | i | i } n | i) o | i' | i) n | | _ | S(
Nt readR t nowaitt
update_nowaits Unknown lockmode '%s'sy No column-based properties specified for refresh operation. Use session.expire() to reload collections and related items.s4 Query contains no columns with which to SELECT from.Rl R^ R R t
for_update(+ R R R) R8 R* R( R R R RL R t eager_joinsR R R R R t primary_columnsRA R R R R RW t find_columnsR R R R R5 R Ri Rj RX R_ t secondary_columnst splice_joinst stop_ont append_fromt append_order_byt copy_and_processt eager_order_byR- ( R R R` R R\ R R R R t order_by_col_exprt innerRm R R t
eager_joinR ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s
=
%
9
c C s x | i i D]v \ } \ } } } } } | i } | oK | o | i | } n | i | t t } t i | i | | _ q q Wd S( s@ Apply single-table-inheritance filtering.
For all distinct single-table-inheritance mappers represented in the
columns clause of this query, add criterion to the WHERE clause of the
given QueryContext such that only the appropriate subtypes are
selected from the total results.
N( RQ R t _single_table_criterionR1 R R* R R R ( R R` R\ R R_ R Rk t wt single_crit( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR " s c C s t | i i S( N( t strR R ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt __str__3 s N(m R t
__module__t __doc__R( RJ RH RN RV R Ro Rq R% R R R R% R R R R R R R R R R R R Rj R t" _Query__no_clauseelement_conditiont _Query__no_statement_conditiont _Query__no_limit_offsetR R R R R R R R R RT R Ru t classmethodR t
deprecatedR R R R R R R t
_from_selfR R t _valuesR R R R R R R R R
t accepts_a_list_as_starargsR R R R R R R R R R R R RD RF RO RG RP RQ RR RS RU RW R[ R] Ra R_ Rc t iterate_instancesR R R R R* R R R R8 R R R ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR 8 s "
"
C
M:
^ p n RK c B s e Z d Z d Z d Z RS( s: represent an entity column returned within a Query result.c O sV | t j o< | d } t | t o t | o
t } qI t } n t i | S( Ni ( RK Rg R R R R t objectR ( R R R R\ ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR : s
c C s+ | i i | i } | i i | _ | S( N( R R R RS ( R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR C s ( R R R R R ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRK 7 s R c B sV e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
RS( s mapper/class/AliasedClass entityc C s6 | i | _ | i i | | g | _ | | _ d S( N( RL R R RI R ( R t queryR\ ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRJ K s
c C s | | _ | i i | _ | | _ | | _ | | _ d | _ | | _ | o | | _ | _ | _
n | i | _ | | _ | _
d S( N( R R R_ R] t _with_polymorphicR( t _polymorphic_discriminatorR^ t path_entityR\ R t base_mapper( R R\ R R_ Rl R^ RT ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRZ R s c C s | d j o | i | i d S| i i | | \ } } | | _ | | _ | i p" | | _ | i | | | _ n d S( N(
R( Rq R t _with_polymorphic_argsR R R^ R] Ro R_ ( R R R R] R t mappersRl ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR ` s
c C s/ t | o | | i j S| i | i j Sd S( N( R R R ( R R\ ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR) o s
c C s d } | i o& | i o | i i | i d } n | o | i o
| i } n | o* | i o | i | i } q | } n
| i } | S( N( R( R^ RD Ru R R_ RF t wrap( R R R` R_ RV ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt _get_entity_clausesu s
c sT | i | | } | i o | o | i | i } n | p
| i } n | o, | i i o t i | i | i i } n | i oF | i i
| | i f | d | i d | i
d | i d | i n( | i i
| | i f | d | i | o f d } n f d } | i o | i i } n | i i i } | | f S( NR R R t polymorphic_discriminatorc s | | d S( N( ( R` Ro Re ( t _instance( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt main s c s
| d S( N( R( ( R` Ro ( R ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s ( R R_ R R t _requires_row_aliasingRW RX R] RY R t _instance_processorR R RA R R R^ R\ t _sa_label_nameR R ( R R R` R R_ R t entname( ( R s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRt s(
c
C s6 | i | | } | i i | i | i t j oI | i i o< | i i | _ | o" | i t i | i | _ q~ n xo | i i
| i D]X } | i o | i
| i j o q n | i | | | i f | d | i d | i q W| i o8 | o | i | i } n
| i } | i i | n d S( NR t column_collection( R R R R] R R* R t
adapt_listR RM t _iterate_polymorphic_propertiesR RA R t setupR R R R ( R R R` R_ R t pd( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s, &
c C s
t | i S( N( R R ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s ( R R R RJ RZ R R) R Rt R R ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR H s $ R c B sM e Z d Z d Z d Z d Z d Z d Z d Z d Z RS( s Column/expression based entity.c s t | t o t i | } | i | _ nE t | t i o | i | _ | i } n t
| d d | _ t | t i
oY t | d oI x0 | i D]% } | | j o Pn t | | q W| | j o d Sn t | t i
p t i d | n | i p | i d } n | i i | | | _ t | _ t | i t i f d t i | h D | _ | i o t | i d | _! n
d | _! d S( NR t _select_iterables Invalid column expression '%r'c 3 sG x@ | ]9 } d | i j o# i | i o | i d Vq q Wd S( R N( R{ R t
_from_objects( R R| ( t actual_froms( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pys s i (" Rg R R R t namet
_result_labelR
R* R R R R( R t
ColumnElementRR R R R R t _labelRl RL R R R4 R R R t
OrderedSetR t iterateRI R R ( R R R R ( ( R s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRJ s: $
c C s | | _ | i i | d S( N( R] R R0 ( R R\ R R_ Rl R^ RT ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRZ s c C sC t | o | | i j St | i o | i i | i Sd S( N( R R R R+ ( R R\ ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR)
s
c C s | i | t t S( N( R R* R8 ( R R t exprR` ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt# _resolve_expr_against_query_aliases s c sR | i | | i | | i o | i i n f d } | | i f S( Nc s | S( N( ( R` Ro ( R ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRn s ( R R R_ R R
( R R R` R Rn ( ( R s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRt s
c C sD | i | | i | } | i t | i 7_ | i i | d S( N( R R R R R R ( R R R` R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR ! s c C s
t | i S( N( R R ( R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR & s (
R R R RJ RZ R) R Rt R R ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR s 7 c B s e Z d Z RS( c C sk | i oJ t | i t i o$ | i i o | i i | _ q | i | _ nu d | _ | i | _ | i
| _ | i | _
| i
o= g } t i | i
D] } | t i | q ~ | _
n | | _ | i | _ | i | _ | i | _ | i | _ g | _ g | _ g | _ | i | _ h | _ g | _ d | _ t! | i" | _# | i$ i% | _& d S( N(' R0 Rg R Rh R^ t apply_labelsR R( RC R R3 R R+ R R RM R
R R& R< R R= R RB R R R R R9 R R R R_ R4 R' R R? RS R
( R R R R ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRJ , s0
$
= ( R R RJ ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR + s t AliasOptionc B s e Z d Z d Z RS( c C s
| | _ d S( N( Ri ( R Ri ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRJ M s c C sQ t | i t o | i i i | i } n
| i } t i | | _ d S( N( Rg Ri R R Rb RW RX RF ( R R Ri ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR P s ( R R RJ R ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyR K s l c C s. t i z t d 7a t SWd t i Xd S( Ni ( t _id_lockt acquiret _runidt release( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyRp [ s
N(4 R t itertoolsR t operatorR t
sqlalchemyR R R R R R R RX t sqlalchemy.sqlRW R R R R
R R R
R t sqlalchemy.orm.utilR R R R R R R R R R2 t __all__R R% R R RK R R t class_loggerR t MapperOptionR R t threadingt LockR Rp ( ( ( s8 /usr/lib/python2.6/site-packages/sqlalchemy/orm/query.pyt s: " (@ Z