-h >SrSSKrSSKrSSKrSSKJr SSKJr SSKJr SSKJ r SSK J r SS K Jr SS K Jr SS K Jr SS K Jr SS K Jr SSK Jr SSK Jr SSKJr SSK Jr SSK Jr SSK Jr SSK Jr SSK Jr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJ r SSKJ r SSKJ!r! SSKJ"r" SSKJ#r# SSKJ$r$ SSKJ r% SS KJ&r& SS!K'J(r( SS"K)J*r* SS#K)J+r+ SS$K)J,r, SS%K-J.r. SS&K-J/r/ SS'K-J0r0 SS(K-J1r1 SS)K-J2r2 SS*K-J3r3 SS+K-J4r4 SS,K-J5r5 SS-K-J6r6 SS.K-J7r7 SS/K8J9r9 SS0K J:r: /S1Qr;\Rx\Rz"S2S3\/\(\3\4\2\,555r>"S4S5\1\6\,5r?"S6S7\R5rA"S8S9\B5rC"S:S;\C5rD"S<S=\C5rEg)>aThe Query class and support. Defines the :class:`_query.Query` class, the central construct used by the ORM to construct database queries. The :class:`_query.Query` class should not be confused with the :class:`_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. N)exc) interfaces)loading)util) _assertions_column_descriptions)$_legacy_determine_last_joined_entity)_legacy_filter_by_entity_zero)LABEL_STYLE_LEGACY_ORM)ORMCompileState)ORMFromStatementCompileState) QueryContext)ORMColumnsClauseRole)aliased) AliasedClass) object_mapper) with_parent)with_polymorphic)inspect) inspection)log)sql) coercions)elements) expression)roles)Select)visitors)SupportsCloneAnnotations)_entity_namespace_key) _generative) Executable)_MemoizedSelectEntities)_SelectFromElements) ForUpdateArg)GroupedElement)HasHints) HasPrefixes) HasSuffixes)LABEL_STYLE_TABLENAME_PLUS_COL) SelectBase)SelectStatementGrouping)InternalTraversal)collections_abc)Queryrrc\rSrSrSrSrSrSrSrSr Sr Sr Sr Sr SrSrSrSrSr\rSr\R.r\R4SS0-r\R:rSrSr Sr!Sr"\RF"5r$SSjr%S r&S r'S r(S r)S r*\+S5r,Sr-Sr.SSjr/SSjr0Sr1Sr2Sr3\4S5r5SSjr6Sr7\4S5r8SSjr9SSjr:SSjr;SSjr5rW\+S?5rX\+S@5rY\R"SASBSS89\R"SC5SSDj55r[\+SSEj5r\\+SF5r]\R"SGSHS+9SI5r^SJr_\+SK5r`\+SSLj5ra\R|"SSM5SN5rb\brc\R|"SSO5SP5rd\+SQ5re\+SR5rf\R|"SSS5ST5rg\+SU5rhSVriSWrj\+SX5rk\+SSYj5rl\+SZ5rmS[rn\+\O"\2\35S\55ro\RS]5r!S^rqS_rr\+\O"\2\35S`55rs\+\O"\2\35Sa55rt\+\O"\2\35Sb55ruScrvSdrwSerxSfrySgrzShr{Sir|Sjr}\+\O"\2\35Sk55r~Slr\+\O"\25Sm55r\+\O"\15Sn55r\R"SoSpS+9\+\O"\15Sq555rSrr\+\O"\25Ss55r\+\O"\25St55r\+\O"\25Su55r\+\O"\25Sv55rSwr\+\O"\15Sx55rSyrSzrS{rS|rS}rS~rSrSr\4S5rSSjr\R"SSSSS9SSj5rSrSrSSjrSSjrSSjrSSjrSrg)r2La9ORM-level SQL construction object. :class:`_query.Query` is the source of all SELECT statements generated by the ORM, both those formulated by end-user query operations as well as by high level internal operations such as related collection loading. It features a generative interface whereby successive calls return a new :class:`_query.Query` object, a copy of the former with additional criteria and options associated with it. :class:`_query.Query` objects are normally initially generated using the :meth:`~.Session.query` method of :class:`.Session`, and in less common cases by instantiating the :class:`_query.Query` directly and associating with a :class:`.Session` using the :meth:`_query.Query.with_session` method. For a full walk through of :class:`_query.Query` usage, see the :ref:`ormtutorial_toplevel`. NFT_legacy_uniquingc2X lURU5 g)a?Construct a :class:`_query.Query` directly. E.g.:: q = Query([User, Address], session=some_session) The above is equivalent to:: q = some_session.query(User, Address) :param entities: a sequence of entities and/or SQL expressions. :param session: a :class:`.Session` with which the :class:`_query.Query` will be associated. Optional; a :class:`_query.Query` can be associated with a :class:`.Session` generatively via the :meth:`_query.Query.with_session` method as well. .. seealso:: :meth:`.Session.query` :meth:`_query.Query.with_session` N)session _set_entities)selfentitiesr8s iC:\Users\ROHAN GUPTA\OneDrive\Desktop\mathbuddy-assessment\venv\Lib\site-packages\sqlalchemy/orm/query.py__init__Query.__init__s8  8$c<[R"U5UlU$N)r immutabledict_propagate_attrs)r:valuess r<_set_propagate_attrsQuery._set_propagate_attrss $ 2 26 : r?c [R"U5Vs/sH(n[R"[R UUSS9PM* snUlgs snfNTapply_propagate_attrs post_inspect)rto_listrexpectrColumnsClauseRole _raw_columns)r:r;ents r<r9Query._set_entitiessS||H- .   ''&*!   .  s/AcUR(dgURSnSUR;aURS$[U[5(a UR$SUR;aURS$[ R "U5H$nSUR;dMURSs $ g)Nr parententitybundle)rO _annotations isinstancerentityr!iterate)r:rPelements r<_entity_from_pre_ent_zeroQuery._entity_from_pre_ent_zeros  " S-- -##N3 3 1 2 2::  )) )##H- -$++C0!W%9%99"//??1r?c[UR5S:wd;SURSR;dURSR(d[R "SU-5eURSRS$)NrrSrz4%s() can only be used against a single mapped class.)lenrOrU is_selectablesa_excInvalidRequestError)r:methnames r<_only_full_mapper_zeroQuery._only_full_mapper_zeros !! "a 'T%6%6q%9%F%FF$$Q'55,,)+34    #00@@r?c UVs/sH(n[R"[RUSUS9PM* nnU=RSU0- sl[ U5Ulgs snf)NT) allow_selectrJ_set_base_alias)rrMrStrictFromClauseRole_compile_optionstuple _from_obj)r:objset_base_aliaselemfas r<_set_select_fromQuery._set_select_fromsn    **!&*      "3^!DDr s/Ac2U=RSU0- slg)N_lazy_loaded_from load_options)r:states r<_set_lazyload_fromQuery._set_lazyload_froms 1599r?c$URSSSS9$NgetForder_bydistinct)_no_criterion_conditionr:s r<_get_conditionQuery._get_conditions!++ EE,  r?c&URSSSS9 gry)_no_criterion_assertionrs r<_get_existing_conditionQuery._get_existing_conditions $$UUU$Kr?cUR(dgUR(dURc}UR(dlUR(d[UR cNUR cAUR(d0U(aUR(dU(a+UR(a[R"SU-5eggNz4661 ?? &  ! !lD%9 9 !!:<<!7r?cUR(dgUR(a[R"SU-5eUR U5 gr)rrr_r`r~r:rs r<_no_clauseelement_condition!Query._no_clauseelement_conditionsG&&   ! !,,2489  $$T*r?ctUR(dgURb[R"SU-5eg)Nz[Query.%s() being called on a Query with an existing full statement - can't apply criterion.)rrr_r`rs r<_no_statement_conditionQuery._no_statement_condition(s?&&  ?? &,,9   'r?cUR(dgURc URb[R"SU<SU<S35eg)NzQuery.zL() being called on a Query which already has LIMIT or OFFSET applied. Call z*() before limit() or offset() are applied.)rrrr_r`rs r<_no_limit_offsetQuery._no_limit_offset4sJ&&     )T-@-@-L,,#'. .Mr?cHURSL=(d URSL$rA)rrrs r<_has_row_limiting_clauseQuery._has_row_limiting_clause>s'   d * Md.A.A.M r?c 0n0nU(aX&S'U(aXS'U(a XFS'SUS'U(a[U5US'U(aXVS'U(aU=RU- slU(aU=RU- slU$)N_version_check_populate_existing_refresh_stateT_for_refresh_state_only_load_props_refresh_identity_token) frozensetrtrh)r:populate_existing version_checkonly_load_props refresh_stateidentity_tokenrtcompile_optionss r< _get_optionsQuery._get_optionsDs  -:) * 1B- . -:) *48O0 1 2;O2LO. / 6D2 3     -    ! !_ 4 ! r?c"UR5$rA) _generaters r<_clone Query._clonebs~~r?cURR(d+URR(dURSS9nOUR SS9R nUR (aURUR 5nU$)zThe full SELECT statement represented by this Query. The statement by default will not have disambiguating labels applied to the construct unless with_labels(True) is called first. T for_statement)rhrf_with_polymorphic_adapt_map _statement_20_compile_state statement_paramsparams)r:stmts r<rQuery.statementesn<%%55))EE%%D%9D&&T&:DDD <<;;t||,D r?cTUR5nURUS9R$)aReturn the 'final' SELECT statement for this :class:`.Query`. This is the Core-only select() that will be rendered by a complete compilation of this query, and is what .statement used to return in 1.3. This method creates a complete compile state so is fairly expensive. )use_legacy_query_style)rrr)r:legacy_query_styleqs r<_final_statementQuery._final_statements/ KKM#5  ) r?c>URR(a\URRHBnU"U5nUcMX@LdMUnUR(aM+U=RSS0- slMD URnUUUS.- nURbf[ UR UR5nURRURURUURURS9 Ok[R"S 0URD6nURRURUURS9 URR!SS5 SUR;a#URR#SSS .5Ul U$) N_bake_okF)_for_statement_use_legacy_query_style) _with_options_with_context_optionsrh_execution_optionsrC) _label_stylerhrCr8compile_state_pluginorm)rplugin_subjectr5)dispatchbefore_compilerrhr FromStatementrO__dict__updaterrrrCr _create_raw_selectrpopunion)r:rrfn new_queryrrs r<rQuery._statement_20sr == ' 'mm22tH (Y-B$D;;;--*e1DD- 3//+'=   ?? & !2!2DOODD MM "00&*&@&@!0#'#:#:!%!6!6 ! ,,=t}}=D MM !..!0!%!6!6 !  MM  i . ")>)> >$($9$9$?$?).$G%D ! r?cURS5nU(aUR[5nURnU(aUR 5nUR US9$)aReturn the full SELECT statement represented by this :class:`_query.Query`, embedded within an :class:`_expression.Alias`. Eager JOIN generation within the query is disabled. :param name: string name to be assigned as the alias; this is passed through to :meth:`_expression.FromClause.alias`. If ``None``, a name will be deterministically generated at compile time. :param with_labels: if True, :meth:`.with_labels` will be called on the :class:`_query.Query` first to apply table-qualified labels to all columns. :param reduce_columns: if True, :meth:`_expression.Select.reduce_columns` will be called on the resulting :func:`_expression.select` construct, to remove same-named columns where one also refers to the other via foreign key or WHERE clause equivalence. F)name)enable_eagerloadsset_label_styler-rreduce_columnsalias)r:r with_labelsrrs r<subqueryQuery.subquerysS8  " "5 ) !!"@AA KK   "AwwDw!!r?cTURS5RRXUS9$)aReturn the full SELECT statement represented by this :class:`_query.Query` represented as a common table expression (CTE). Parameters and usage are the same as those of the :meth:`_expression.SelectBase.cte` method; see that method for further details. Here is the `PostgreSQL WITH RECURSIVE example `_. Note that, in this example, the ``included_parts`` cte and the ``incl_alias`` alias of it are Core selectables, which means the columns are accessed via the ``.c.`` attribute. The ``parts_alias`` object is an :func:`_orm.aliased` instance of the ``Part`` entity, so column-mapped attributes are available directly:: from sqlalchemy.orm import aliased class Part(Base): __tablename__ = 'part' part = Column(String, primary_key=True) sub_part = Column(String, primary_key=True) quantity = Column(Integer) included_parts = session.query( Part.sub_part, Part.part, Part.quantity).\ filter(Part.part=="our part").\ cte(name="included_parts", recursive=True) incl_alias = aliased(included_parts, name="pr") parts_alias = aliased(Part, name="p") included_parts = included_parts.union_all( session.query( parts_alias.sub_part, parts_alias.part, parts_alias.quantity).\ filter(parts_alias.part==incl_alias.c.sub_part) ) q = session.query( included_parts.c.sub_part, func.sum(included_parts.c.quantity). label('total_quantity') ).\ group_by(included_parts.c.sub_part) .. seealso:: :meth:`_expression.HasCTE.cte` F)r recursivenesting)rrcte)r:rrrs r<r Query.ctes3n%%e,66::G;  r?cVURS5RRU5$)zReturn the full SELECT statement represented by this :class:`_query.Query`, converted to a scalar subquery with a label of the given name. Analogous to :meth:`sqlalchemy.sql.expression.SelectBase.label`. F)rrlabel)r:rs r<r Query.label3s&%%e,66<s##%%r?cTURS5RR5$)a9Return the full SELECT statement represented by this :class:`_query.Query`, converted to a scalar subquery. Analogous to :meth:`sqlalchemy.sql.expression.SelectBase.scalar_subquery`. .. versionchanged:: 1.4 The :meth:`_query.Query.scalar_subquery` method replaces the :meth:`_query.Query.as_scalar` method. F)rrrrs r<rQuery.scalar_subqueryKs$%%e,66FFHHr?c"UR5$)zReturn the :class:`_expression.Select` object emitted by this :class:`_query.Query`. Used for :func:`_sa.inspect` compatibility, this is equivalent to:: query.enable_eagerloads(False).with_labels().statement )__clause_element__rs r< selectableQuery.selectableYs&&((r?c\URSSS9R[5R$)NFT)_enable_eagerloads_render_for_subquery)_with_compile_optionsrr-rrs r<rQuery.__clause_element__es1  & &#(t ' _; < Y  r?c<U=R[US9- slg)zWhen set to True, the query results will always be a tuple. This is specifically for single element queries. The default is False. .. versionadded:: 1.2.5 .. seealso:: :meth:`_query.Query.is_single_entity` )_only_return_tuplesN)rtdictr:values r<only_return_tuplesQuery.only_return_tuplesns Te<<r?cURR(+=(al [UR5S:H=(aM SURSR;=(a* [ URSRS[ 5$)a@Indicates if this :class:`_query.Query` returns tuples or single entities. Returns True if this query returns a single entity for each instance in its result list, and False if this query returns a tuple of entities for each result. .. versionadded:: 1.3.11 .. seealso:: :meth:`_query.Query.only_return_tuples` rrSr)rtrr]rOrUrVrrs r<is_single_entityQuery.is_single_entity}s|"!!55 5 D%%&!+ $"3"3A"6"C"CC !!!$11.A$  r?c2U=RSU0- slg)aControl whether or not eager joins and subqueries are rendered. When set to False, the returned Query will not render eager joins regardless of :func:`~sqlalchemy.orm.joinedload`, :func:`~sqlalchemy.orm.subqueryload` options or mapper-level ``lazy='joined'``/``lazy='subquery'`` configurations. This is used primarily when nesting the Query's statement into a subquery or other selectable, or when using :meth:`_query.Query.yield_per`. rNrhrs r<rQuery.enable_eagerloadss "6!>>r?c .U=RU- slgrAr )r:opts r<rQuery._with_compile_optionss $r?zB:meth:`_orm.Query.with_labels` and :meth:`_orm.Query.apply_labels`z_; 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. .. note:: The :meth:`_query.Query.set_label_style` method *only* applies the output of :attr:`_query.Query.statement`, and *not* to any of the result-row invoking systems of :class:`_query.Query` itself, e.g. :meth:`_query.Query.first`, :meth:`_query.Query.all`, etc. To execute a query using :meth:`_query.Query.set_label_style`, invoke the :attr:`_query.Query.statement` using :meth:`.Session.execute`:: result = session.execute( query .set_label_style(LABEL_STYLE_TABLENAME_PLUS_COL) .statement ) .. versionadded:: 1.4 )rr)r:styles r<rQuery.set_label_styles)<   E )>>#D %  r?cXlg)aControl whether assertions are generated. When set to False, the returned Query will not assert its state before certain operations, including that LIMIT/OFFSET has not been applied when filter() is called, no criterion exists when get() is called, and no "from_statement()" exists when filter()/order_by()/group_by() etc. is called. This more permissive mode is used by custom Query subclasses to specify criterion or other modifiers outside of the usual usage patterns. Care should be taken to ensure that the usage pattern is even possible. A statement applied by from_statement() will override any criterion set by filter() or order_by(), for example. N)rrs r<enable_assertionsQuery.enable_assertionss (#(r?ch[RRRUR5$)zA readonly attribute which returns the current WHERE criterion for this Query. This returned value is a SQL expression construct, or ``None`` if no criterion has been established. )rrBooleanClauseList_construct_for_whereclauserrs r< whereclauseQuery.whereclauses*||--HH    r?c2U=RSU0- slg)zindicate 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. _current_pathNr )r:paths r<_with_current_pathQuery._with_current_paths /4!88r?z#:meth:`_orm.Query.with_polymorphic`z2Use the orm.with_polymorphic() standalone functionc[U5n[UUUUS9nURRSU[ U5445Ulg)aLoad columns for inheriting classes. This is a legacy method which is replaced by the :func:`_orm.with_polymorphic` function. .. warning:: The :meth:`_orm.Query.with_polymorphic` method does **not** support 1.4/2.0 style features including :func:`_orm.with_loader_criteria`. Please migrate code to use :func:`_orm.with_polymorphic`. :meth:`_query.Query.with_polymorphic` applies transformations to the "main" mapped class represented by this :class:`_query.Query`. The "main" mapped class here means the :class:`_query.Query` object's first argument is a full class, i.e. ``session.query(SomeClass)``. These transformations allow additional tables to be present in the FROM clause so that columns for a joined-inheritance subclass are available in the query, both for the purposes of load-time efficiency as well as the ability to use these columns at query time. .. seealso:: :ref:`with_polymorphic` - illustrates current patterns )rpolymorphic_onrN)r rrhadd_to_elementr)r:cls_or_mappersrr'rWwps r<rQuery.with_polymorphicsQF/t4   !)  !% 5 5 D D )VWR[,A+C! r?c2U=RSU0- slg)a)Yield only ``count`` rows at a time. The purpose of this method is when fetching very large result sets (> 10K rows), to batch results in sub-collections and yield them out partially, so that the Python interpreter doesn't need to declare very large areas of memory which is both time consuming and leads to excessive memory use. The performance from fetching hundreds of thousands of rows can often double when a suitable yield-per setting (e.g. approximately 1000) is used, even with DBAPIs that buffer rows (which are most). As of SQLAlchemy 1.4, the :meth:`_orm.Query.yield_per` method is equivalent to using the ``yield_per`` execution option at the ORM level. See the section :ref:`orm_queryguide_yield_per` for further background on this option. .. seealso:: :ref:`orm_queryguide_yield_per` _yield_perNrs)r:counts r< yield_perQuery.yield_perCs. lE22r?z:meth:`_orm.Query.get`z7The method is now available as :meth:`_orm.Session.get`)rbecomes_legacycdURSSSS9 URU[R5$)a Return an instance based on the given primary key identifier, or ``None`` if not found. E.g.:: my_user = session.query(User).get(5) some_object = session.query(VersionedFoo).get((5, 10)) some_object = session.query(VersionedFoo).get( {"id": 5, "version_id": 10}) :meth:`_query.Query.get` is special in that it provides direct access to the identity map of the owning :class:`.Session`. If the given primary key identifier is present in the local identity map, the object is returned directly from this collection and no SQL is emitted, unless the object has been marked fully expired. If not present, a SELECT is performed in order to locate the object. :meth:`_query.Query.get` also will perform a check if the object is present in the identity map and marked as expired - a SELECT is emitted to refresh the object as well as to ensure that the row is still present. If not, :class:`~sqlalchemy.orm.exc.ObjectDeletedError` is raised. :meth:`_query.Query.get` is only used to return a single mapped instance, not multiple instances or individual column constructs, and strictly on a single primary key value. The originating :class:`_query.Query` must be constructed in this way, i.e. against a single mapped entity, with no additional filtering criterion. Loading options via :meth:`_query.Query.options` may be applied however, and will be used if the object is not yet locally present. :param ident: A scalar, tuple, or dictionary representing the primary key. For a composite (e.g. multiple column) primary key, a tuple or dictionary should be passed. For a single-column primary key, the scalar calling form is typically the most expedient. If the primary key of a row is the value "5", the call looks like:: my_object = query.get(5) The tuple form contains primary key values typically in the order in which they correspond to the mapped :class:`_schema.Table` object's primary key columns, or if the :paramref:`_orm.Mapper.primary_key` configuration parameter were used, in the order used for that parameter. For example, if the primary key of a row is represented by the integer digits "5, 10" the call would look like:: my_object = query.get((5, 10)) The dictionary form should include as keys the mapped attribute names corresponding to each element of the primary key. If the mapped class has the attributes ``id``, ``version_id`` as the attributes which store the object's primary key value, the call would look like:: my_object = query.get({"id": 5, "version_id": 10}) .. versionadded:: 1.3 the :meth:`_query.Query.get` method now optionally accepts a dictionary of attribute names to values in order to indicate a primary key identifier. :return: The object instance, or ``None``. rzFr{)r _get_implrload_on_pk_identity)r:idents r<rz Query.get\s3f $$UUU$K~~eW%@%@AAr?c URS5nURRUUUURRUR UR UURS9$)Nrz)rwith_for_updateoptionsrexecution_options)rbr8r3rtr_for_update_argrr)r:primary_key_identity db_load_fnrmappers r<r3Query._get_implsd,,U3||%%  "//BB 00&&)"55&  r?c.URR$)a`An :class:`.InstanceState` that is using this :class:`_query.Query` for a lazy load operation. .. deprecated:: 1.4 This attribute should be viewed via the :attr:`.ORMExecuteState.lazy_loaded_from` attribute, within the context of the :meth:`.SessionEvents.do_orm_execute` event. .. seealso:: :attr:`.ORMExecuteState.lazy_loaded_from` )rtrrrs r<lazy_loaded_fromQuery.lazy_loaded_froms  222r?c.URR$rA)rhr"rs r<r"Query._current_paths$$222r?cSUlU(aUSS;aSUlg[UR5RSU55Ulg)aReturn a :class:`.Query` construct which will correlate the given FROM clauses to that of an enclosing :class:`.Query` or :func:`~.expression.select`. The method here accepts mapped classes, :func:`.aliased` constructs, and :func:`.mapper` constructs as arguments, which are resolved into expression constructs, in addition to appropriate expression constructs. The correlation arguments are ultimately passed to :meth:`_expression.Select.correlate` after coercion to expression constructs. The correlation arguments take effect in such cases as when :meth:`_query.Query.from_self` is used, or when a subquery as returned by :meth:`_query.Query.subquery` is embedded in another :func:`_expression.select` construct. Fr>FNr5c3l# UH*n[R"[RU5v M, g7frA)rrMrFromClauseRole).0fs r< "Query.correlate..s)9CNa   !5!5q99;24N)_auto_correlate _correlatesetr)r: fromclausess r< correlateQuery.correlatesI, % ;q>]: DO!$//2889CN9DOr?c2U=RSU0- slg)aReturn a Query with a specific 'autoflush' setting. As of SQLAlchemy 1.4, the :meth:`_orm.Query.autoflush` method is equivalent to using the ``autoflush`` execution option at the ORM level. See the section :ref:`orm_queryguide_autoflush` for further background on this option. _autoflushNrs)r:settings r< autoflushQuery.autoflushs lG44r?c2U=RSS0- slg)aReturn a :class:`_query.Query` that will expire and refresh all instances as they are loaded, or reused from the current :class:`.Session`. As of SQLAlchemy 1.4, the :meth:`_orm.Query.populate_existing` method is equivalent to using the ``populate_existing`` execution option at the ORM level. See the section :ref:`orm_queryguide_populate_existing` for further background on this option. rTNrsrs r<rQuery.populate_existings 2D99r?c2U=RSU0- slg)zSet the 'invoke all eagers' flag which causes joined- and subquery loaders to traverse into already-loaded related objects and collections. Default is that of :attr:`_query.Query._invoke_all_eagers`. _invoke_all_eagersNrsrs r<_with_invoke_all_eagersQuery._with_invoke_all_eagerss 2E::r?z:meth:`_orm.Query.with_parent`z6Use the :func:`_orm.with_parent` standalone construct.zsqlalchemy.orm.relationshipsc[RRnU(a [U5nO [ U5nUc[ U5nUR H<n[XtR5(dMURURLdM:Un OS [R"SURRR<SURR<S35eUR[!XUR"55$)aAdd filtering criterion that relates the given instance to a child object or collection, using its attribute state as well as an established :func:`_orm.relationship()` configuration. The method uses the :func:`.with_parent` function to generate the clause, the result of which is passed to :meth:`_query.Query.filter`. Parameters are the same as :func:`.with_parent`, with the exception that the given property can be None, in which case a search is performed against this :class:`_query.Query` object's target mapper. :param instance: An instance which has some :func:`_orm.relationship`. :param property: String property name, or class-bound attribute, which indicates what relationship from the instance should be used to reconcile the parent/child relationship. :param from_entity: Entity in which to consider as the left side. This defaults to the "zero" entity of the :class:`_query.Query` itself. z>Could not locate a property which relates instances of class 'z' to instances of class '')r preloadedorm_relationshipsrr riterate_propertiesrVRelationshipPropertyr>r_r`class___name__ __class__filterrrW)r:instanceproperty from_entity relationships entity_zeror>props r<rQuery.with_parentsB88 !+.K7=K  "8,F11t%G%GHH {'9'99#H 200$**11:: **33 {{;x;;M;MNOOr?cUb [X5n[UR5UlURR[R "[ RXS95 g)zAadd a mapped entity to the list of result columns to be returned.NrJ)rlistrOappendrrMrrN)r:rWrs r< add_entityQuery.add_entityXsT  V+F !2!23     ''  r?cXlg)aReturn a :class:`_query.Query` that will use the given :class:`.Session`. While the :class:`_query.Query` object is normally instantiated using the :meth:`.Session.query` method, it is legal to build the :class:`_query.Query` directly without necessarily using a :class:`.Session`. Such a :class:`_query.Query` object, or any :class:`_query.Query` already associated with a different :class:`.Session`, can produce a new :class:`_query.Query` object associated with a target session using this method:: from sqlalchemy.orm import Query query = Query([MyClass]).filter(MyClass.id == 5) result = query.with_session(my_session).one() N)r8)r:r8s r< with_sessionQuery.with_sessionis 0 r?z:meth:`_query.Query.from_self`zThe new approach is to use the :func:`.orm.aliased` construct in conjunction with a subquery. See the section :ref:`Selecting from the query itself as a subquery ` in the 2.0 migration notes for an example.c UR"U6$)areturn a Query that selects from this Query's SELECT statement. :meth:`_query.Query.from_self` essentially turns the SELECT statement into a SELECT of itself. Given a query such as:: q = session.query(User).filter(User.name.like('e%')) Given the :meth:`_query.Query.from_self` version:: q = session.query(User).filter(User.name.like('e%')).from_self() This query renders as: .. sourcecode:: sql SELECT anon_1.user_id AS anon_1_user_id, anon_1.user_name AS anon_1_user_name FROM (SELECT "user".id AS user_id, "user".name AS user_name FROM "user" WHERE "user".name LIKE :name_1) AS anon_1 There are lots of cases where :meth:`_query.Query.from_self` may be useful. A simple one is where above, we may want to apply a row LIMIT to the set of user objects we query against, and then apply additional joins against that row-limited set:: q = session.query(User).filter(User.name.like('e%')).\ limit(5).from_self().\ join(User.addresses).filter(Address.email.like('q%')) The above query joins to the ``Address`` entity but only against the first five results of the ``User`` query: .. sourcecode:: sql SELECT anon_1.user_id AS anon_1_user_id, anon_1.user_name AS anon_1_user_name FROM (SELECT "user".id AS user_id, "user".name AS user_name FROM "user" WHERE "user".name LIKE :name_1 LIMIT :param_1) AS anon_1 JOIN address ON anon_1.user_id = address.user_id WHERE address.email LIKE :email_1 **Automatic Aliasing** Another key behavior of :meth:`_query.Query.from_self` is that it applies **automatic aliasing** to the entities inside the subquery, when they are referenced on the outside. Above, if we continue to refer to the ``User`` entity without any additional aliasing applied to it, those references will be in terms of the subquery:: q = session.query(User).filter(User.name.like('e%')).\ limit(5).from_self().\ join(User.addresses).filter(Address.email.like('q%')).\ order_by(User.name) The ORDER BY against ``User.name`` is aliased to be in terms of the inner subquery: .. sourcecode:: sql SELECT anon_1.user_id AS anon_1_user_id, anon_1.user_name AS anon_1_user_name FROM (SELECT "user".id AS user_id, "user".name AS user_name FROM "user" WHERE "user".name LIKE :name_1 LIMIT :param_1) AS anon_1 JOIN address ON anon_1.user_id = address.user_id WHERE address.email LIKE :email_1 ORDER BY anon_1.user_name The automatic aliasing feature only works in a **limited** way, for simple filters and orderings. More ambitious constructions such as referring to the entity in joins should prefer to use explicit subquery objects, typically making use of the :meth:`_query.Query.subquery` method to produce an explicit subquery object. Always test the structure of queries by viewing the SQL to ensure a particular structure does what's expected! **Changing the Entities** :meth:`_query.Query.from_self` also includes the ability to modify what columns are being queried. In our example, we want ``User.id`` to be queried by the inner query, so that we can join to the ``Address`` entity on the outside, but we only wanted the outer query to return the ``Address.email`` column:: q = session.query(User).filter(User.name.like('e%')).\ limit(5).from_self(Address.email).\ join(User.addresses).filter(Address.email.like('q%')) yielding: .. sourcecode:: sql SELECT address.email AS address_email FROM (SELECT "user".id AS user_id, "user".name AS user_name FROM "user" WHERE "user".name LIKE :name_1 LIMIT :param_1) AS anon_1 JOIN address ON anon_1.user_id = address.user_id WHERE address.email LIKE :email_1 **Looking out for Inner / Outer Columns** Keep in mind that when referring to columns that originate from inside the subquery, we need to ensure they are present in the columns clause of the subquery itself; this is an ordinary aspect of SQL. For example, if we wanted to load from a joined entity inside the subquery using :func:`.contains_eager`, we need to add those columns. Below illustrates a join of ``Address`` to ``User``, then a subquery, and then we'd like :func:`.contains_eager` to access the ``User`` columns:: q = session.query(Address).join(Address.user).\ filter(User.name.like('e%')) q = q.add_entity(User).from_self().\ options(contains_eager(Address.user)) We use :meth:`_query.Query.add_entity` above **before** we call :meth:`_query.Query.from_self` so that the ``User`` columns are present in the inner subquery, so that they are available to the :func:`.contains_eager` modifier we are using on the outside, producing: .. sourcecode:: sql SELECT anon_1.address_id AS anon_1_address_id, anon_1.address_email AS anon_1_address_email, anon_1.address_user_id AS anon_1_address_user_id, anon_1.user_id AS anon_1_user_id, anon_1.user_name AS anon_1_user_name FROM ( SELECT address.id AS address_id, address.email AS address_email, address.user_id AS address_user_id, "user".id AS user_id, "user".name AS user_name FROM address JOIN "user" ON "user".id = address.user_id WHERE "user".name LIKE :name_1) AS anon_1 If we didn't call ``add_entity(User)``, but still asked :func:`.contains_eager` to load the ``User`` entity, it would be forced to add the table on the outside without the correct join criteria - note the ``anon1, "user"`` phrase at the end: .. sourcecode:: sql -- incorrect query SELECT anon_1.address_id AS anon_1_address_id, anon_1.address_email AS anon_1_address_email, anon_1.address_user_id AS anon_1_address_user_id, "user".id AS user_id, "user".name AS user_name FROM ( SELECT address.id AS address_id, address.email AS address_email, address.user_id AS address_user_id FROM address JOIN "user" ON "user".id = address.user_id WHERE "user".name LIKE :name_1) AS anon_1, "user" :param \*entities: optional list of entities which will replace those being selected. ) _from_selfr:r;s r< from_selfQuery.from_selfsl))r?cUR[5RS5R5R 5nUR U5nU(aUR U5 U$rA)rr-rQr_anonymous_fromclause_from_selectabler9)r:r; fromclausers r<ryQuery._from_self;sU  !? @ Yt_ XZ " " $   ! !* -  OOH %r?c2U=RSU0- slg)N_enable_single_critr )r:vals r<_set_enable_single_critQuery._set_enable_single_critIs "7!==r?cSHnURRUS5 M! URU/U5 U=RSS0- slU=RSS0- slg)N) rrrrr_last_joined_entityr_memoized_select_entitiesr _distinct_on_having_criteria _prefixes _suffixesrF_orm_only_from_obj_alias)rrrorh)r:rset_entity_fromattrs r<rQuery._from_selectableMsl D MM  dD ) zlO<  !5"   "# UH*n[R"[RUTSS9v M, g7f)TrIN)rrMrrN)rHcr:s r<rJ$Query.add_columns..s9!    ''&*!   s25N)rqrOextendrs` r< add_columnsQuery.add_columnss; !!2!23   ! !  r?z:meth:`_query.Query.add_column` is deprecated and will be removed in a future release. Please use :meth:`_query.Query.add_columns`c$URU5$)zGAdd a column expression to the list of result columns to be returned. )rrs r< add_columnQuery.add_columns''r?cX[[R"U55nURR(a.UH'nUR (dMUR U5 M) O-UH'nUR (dMURU5 M) U=RU- slg)a Return a new :class:`_query.Query` object, applying the given list of mapper options. Most supplied options regard changing how column- and relationship-mapped attributes are loaded. .. seealso:: :ref:`deferred_options` :ref:`relationship_loader_options` N) rirflatten_iteratorrhr"_is_legacy_optionprocess_query_conditionally process_queryr)r:argsoptsr s r<r9 Query.optionss"T**401  . .(((33D9(((%%d+ d"r?cU"U5$)aReturn a new :class:`_query.Query` object transformed by the given function. E.g.:: def filter_something(criterion): def transform(q): return q.filter(criterion) return transform q = q.with_transformation(filter_something(x==5)) This allows ad-hoc recipes to be created for :class:`_query.Query` objects. See the example at :ref:`hybrid_transformers`. r5)r:rs r<with_transformationQuery.with_transformations "$xr?cUR$)zGet the non-SQL options which will take effect during execution. .. versionadded:: 1.3 .. seealso:: :meth:`_query.Query.execution_options` )rrs r<get_execution_optionsQuery.get_execution_optionss&&&r?c DURRU5Ulg)a^Set non-SQL options which take effect during execution. Options allowed here include all of those accepted by :meth:`_engine.Connection.execution_options`, as well as a series of ORM specific options: ``populate_existing=True`` - equivalent to using :meth:`_orm.Query.populate_existing` ``autoflush=True|False`` - equivalent to using :meth:`_orm.Query.autoflush` ``yield_per=`` - equivalent to using :meth:`_orm.Query.yield_per` Note that the ``stream_results`` execution option is enabled automatically if the :meth:`~sqlalchemy.orm.query.Query.yield_per()` method or execution option is used. .. versionadded:: 1.4 - added ORM options to :meth:`_orm.Query.execution_options` The execution options may also be specified on a per execution basis when using :term:`2.0 style` queries via the :paramref:`_orm.Session.execution_options` parameter. .. warning:: The :paramref:`_engine.Connection.execution_options.stream_results` parameter should not be used at the level of individual ORM statement executions, as the :class:`_orm.Session` will not track objects from different schema translate maps within a single session. For multiple schema translate maps within the scope of a single :class:`_orm.Session`, see :ref:`examples_sharding`. .. seealso:: :ref:`engine_stream_results` :meth:`_query.Query.get_execution_options` N)rr)r:kwargss r<r:Query.execution_optionssX#'"9"9"?"?"Gr?c([UUUUUS9Ulg)areturn a new :class:`_query.Query` with the specified options for the ``FOR UPDATE`` clause. The behavior of this method is identical to that of :meth:`_expression.GenerativeSelect.with_for_update`. When called with no arguments, the resulting ``SELECT`` statement will have a ``FOR UPDATE`` clause appended. When additional arguments are specified, backend-specific options such as ``FOR UPDATE NOWAIT`` or ``LOCK IN SHARE MODE`` can take effect. E.g.:: q = sess.query(User).populate_existing().with_for_update(nowait=True, of=User) The above query on a PostgreSQL backend will render like:: SELECT users.id AS users_id FROM users FOR UPDATE OF users NOWAIT .. warning:: Using ``with_for_update`` in the context of eager loading relationships is not officially supported or recommended by SQLAlchemy and may not work with certain queries on various database backends. When ``with_for_update`` is successfully used with a query that involves :func:`_orm.joinedload`, SQLAlchemy will attempt to emit SQL that locks all involved tables. .. note:: It is generally a good idea to combine the use of the :meth:`_orm.Query.populate_existing` method when using the :meth:`_orm.Query.with_for_update` method. The purpose of :meth:`_orm.Query.populate_existing` is to force all the data read from the SELECT to be populated into the ORM objects returned, even if these objects are already in the :term:`identity map`. .. seealso:: :meth:`_expression.GenerativeSelect.with_for_update` - Core level method with full argument and behavioral description. :meth:`_orm.Query.populate_existing` - overwrites attributes of objects already loaded in the identity map. )readnowaitof skip_locked key_shareN)r(r;)r:rrrrrs r<r8Query.with_for_update5s!p ,#  r?c[U5S:XaURUS5 O%[U5S:a[R"S5eURR U5Ulg)aSAdd 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. rrzFparams() takes zero or one positional argument, which is a dictionary.N)r]rr_ ArgumentErrorrr)r:rrs r<r Query.paramsusZ t9> MM$q' " Y]&&) ||))&1 r?c UR"U6$)z=A synonym for :meth:`.Query.filter`. .. versionadded:: 1.4 )rgr: criterions r<where Query.wheres {{I&&r?c[U5Hpn[R"[RXS9nUR (a#[ R"USUR 05nU=RU4- slMr g)aApply the given filtering criterion to a copy of this :class:`_query.Query`, using SQL expressions. e.g.:: session.query(MyClass).filter(MyClass.name == 'some name') Multiple criteria may be specified as comma separated; the effect is that they will be joined together using the :func:`.and_` function:: session.query(MyClass).\ filter(MyClass.name == 'some name', MyClass.id > 5) The criterion is any SQL expression object applicable to the WHERE clause of a select. String expressions are coerced into SQL expression constructs via the :func:`_expression.text` construct. .. seealso:: :meth:`_query.Query.filter_by` - filter on keyword expressions. rpaliased_generationN) rqrrMrWhereHavingRole_aliased_generationsql_util_deep_annotaterrs r<rg Query.filtersn6iI!((%%yI ''$33 4d6N6NO  YL 0 )r?cnUR(a$[URUR55$grA)rr rZrs r<rQuery._last_joined_entitys1  # #7(($*H*H*J r?cUR(aURnUbU$UR(a*URR(dURS$UR S$)zfor the filter_by() method, return the target entity for which we will attempt to derive an expression from based on string name. r)rrrjrhrfrO)r:rs r<_filter_by_zeroQuery._filter_by_zeros\  # #"&":": ".**8 >>$"7"7"G"G>>!$ $  ##r?c UR5nUc'[R"SUR5-5eUR 5VVs/sHup4[ X#5U:HPM nnnUR "U6$s snnf)ajApply the given filtering criterion to a copy of this :class:`_query.Query`, using keyword expressions. e.g.:: session.query(MyClass).filter_by(name = 'some name') Multiple criteria may be specified as comma separated; the effect is that they will be joined together using the :func:`.and_` function:: session.query(MyClass).\ filter_by(name = 'some name', id = 5) The keyword expressions are extracted from the primary entity of the query, or the last entity that was the target of a call to :meth:`_query.Query.join`. .. seealso:: :meth:`_query.Query.filter` - filter on SQL expressions. zCan't use filter_by when the first entity '%s' of a query is not a mapped class. Please use the filter method instead, or change the order of the entities in the query)rr_r`_query_entity_zeroitemsr#rg)r:rrjkeyrclausess r< filter_byQuery.filter_bys0**,  ,,C))+, %lln ,  "+ 3u <,  {{G$$  sA:c B[U5S:XaUSbUSSLaSUlg[SU55nUR(a=[UVs/sH&n[R "USUR05PM( sn5nU=RU- slgs snf)a:Apply one or more ORDER BY criteria to the query and return the newly resulting :class:`_query.Query`. e.g.:: q = session.query(Entity).order_by(Entity.id, Entity.name) Calling this method multiple times is equivalent to calling it once with all the clauses concatenated. All existing ORDER BY criteria may be cancelled by passing ``None`` by itself. New ORDER BY criteria may then be added by invoking :meth:`_orm.Query.order_by` again, e.g.:: # will erase all ORDER BY and ORDER BY new_col alone q = q.order_by(None).order_by(new_col) .. seealso:: These sections describe ORDER BY in terms of :term:`2.0 style` invocation but apply to :class:`_orm.Query` as well: :ref:`tutorial_order_by` - in the :ref:`unified_tutorial` :ref:`tutorial_order_by_label` - in the :ref:`unified_tutorial` rrNFr5c3l# UH*n[R"[RU5v M, g7frA)rrMr OrderByRolerHclauses r<rJ!Query.order_by..4-%F  !2!2F;;%rLr)r]rrirrrr:rros r<r|Query.order_bys: w<1 '!*"4 e8K%'D "%I ''! "+ "+A!// 4d6N6NO"+    " "i / "-Bc B[U5S:XaUSbUSSLaSUlg[SU55nUR(a=[UVs/sH&n[R "USUR05PM( sn5nU=RU- slgs snf)aApply one or more GROUP BY criterion to the query and return the newly resulting :class:`_query.Query`. All existing GROUP BY settings can be suppressed by passing ``None`` - this will suppress any GROUP BY configured on mappers as well. .. seealso:: These sections describe GROUP BY in terms of :term:`2.0 style` invocation but apply to :class:`_orm.Query` as well: :ref:`tutorial_group_by_w_aggregates` - in the :ref:`unified_tutorial` :ref:`tutorial_order_by_label` - in the :ref:`unified_tutorial` rrNFr5c3l# UH*n[R"[RU5v M, g7frA)rrMr GroupByRolers r<rJ!Query.group_by.._rrLr)r]rrirrrrs r<group_byQuery.group_byFs, w<1 '!*"4 e8K%'D "%I ''! "+ "+A!// 4d6N6NO"+    " "i / "rcrU=R[R"[RXS94- slg)aApply a HAVING criterion to the query and return the newly resulting :class:`_query.Query`. :meth:`_query.Query.having` is used in conjunction with :meth:`_query.Query.group_by`. HAVING criterion makes it possible to use filters on aggregate functions like COUNT, SUM, AVG, MAX, and MIN, eg.:: q = session.query(User.id).\ join(User.addresses).\ group_by(User.id).\ having(func.count(Address.id) > 2) rpN)rrrMrrrs r<having Query.havingqs3&    %%y "  r?c`URU"U/[U5-6R55$rA)rrqr)r:expr_fnrs r<_set_op Query._set_ops,$$WvQ/?%A%J%J%LMMr?cDUR"[R/UQ76$)aProduce 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) Note that many database backends do not allow ORDER BY to be rendered on a query called within UNION, EXCEPT, etc. To disable all ORDER BY clauses including those configured on mappers, issue ``query.order_by(None)`` - the resulting :class:`_query.Query` object will not render ORDER BY within its SELECT statement. )rrrr:rs r<r Query.unionsJ||J,,1q11r?cDUR"[R/UQ76$)zProduce 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. )rr union_allrs r<rQuery.union_all||J005155r?cDUR"[R/UQ76$)zProduce 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. )rr intersectrs r<rQuery.intersectrr?cDUR"[R/UQ76$)zProduce 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. )rr intersect_allrs r<rQuery.intersect_alls||J449q99r?cDUR"[R/UQ76$)zProduce 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. )rrexcept_rs r<r Query.except_s||J..333r?cDUR"[R/UQ76$)zProduce 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. )rr except_allrs r<rQuery.except_alls||J116A66r?crSUR;aSUlU=RS- slUR$)N_aliased_generation_counterrr)rr rs r<_next_aliased_generationQuery._next_aliased_generations3 ( =/0D , ((A-(///r?c ^^ ^ ^ ^ URSS5URSS5URSS5URSS54um m m m T (dT (a[R"S5 U(a&[SSR [ U55-5eT (dS TlS TlU(a US US S pTOS =pEU(dUc[U[5(dU4/nGOZU(d[U[R[[[R45(aH[U[ R"[$[&R([R45(aX4/nO/n/nU4U-Hn[U[5(a|[R"S 5 U(aUR+S U55 /n[US [$[&R(45(a US US 4nUR-U5 MUR-U5 M U(aUR+SU55 T (aTR/5TlTR(asUVs/sHfn[1U5S:XaRUS [US [R25(a&[4R6"US STR05OUS 4OUPMh nn[U U U U U4Sj[9U555n [1U 5S :a[R"S5 T=R:U - slTR<RSS 5 g s snf)a)Create a SQL JOIN against this :class:`_query.Query` object's criterion and apply generatively, returning the newly resulting :class:`_query.Query`. **Simple Relationship Joins** Consider a mapping between two classes ``User`` and ``Address``, with a relationship ``User.addresses`` representing a collection of ``Address`` objects associated with each ``User``. The most common usage of :meth:`_query.Query.join` is to create a JOIN along this relationship, using the ``User.addresses`` attribute as an indicator for how this should occur:: q = session.query(User).join(User.addresses) Where above, the call to :meth:`_query.Query.join` along ``User.addresses`` will result in SQL approximately equivalent to:: SELECT user.id, user.name FROM user JOIN address ON user.id = address.user_id In the above example we refer to ``User.addresses`` as passed to :meth:`_query.Query.join` as the "on clause", that is, it indicates how the "ON" portion of the JOIN should be constructed. To construct a chain of joins, multiple :meth:`_query.Query.join` calls may be used. The relationship-bound attribute implies both the left and right side of the join at once:: q = session.query(User).\ join(User.orders).\ join(Order.items).\ join(Item.keywords) .. note:: as seen in the above example, **the order in which each call to the join() method occurs is important**. Query would not, for example, know how to join correctly if we were to specify ``User``, then ``Item``, then ``Order``, in our chain of joins; in such a case, depending on the arguments passed, it may raise an error that it doesn't know how to join, or it may produce invalid SQL in which case the database will raise an error. In correct practice, the :meth:`_query.Query.join` method is invoked in such a way that lines up with how we would want the JOIN clauses in SQL to be rendered, and each call should represent a clear link from what precedes it. **Joins to a Target Entity or Selectable** A second form of :meth:`_query.Query.join` allows any mapped entity or core selectable construct as a target. In this usage, :meth:`_query.Query.join` will attempt to create a JOIN along the natural foreign key relationship between two entities:: q = session.query(User).join(Address) In the above calling form, :meth:`_query.Query.join` is called upon to create the "on clause" automatically for us. This calling form will ultimately raise an error if either there are no foreign keys between the two entities, or if there are multiple foreign key linkages between the target entity and the entity or entities already present on the left side such that creating a join requires more information. Note that when indicating a join to a target without any ON clause, ORM configured relationships are not taken into account. **Joins to a Target with an ON Clause** The third calling form allows both the target entity as well as the ON clause to be passed explicitly. A example that includes a SQL expression as the ON clause is as follows:: q = session.query(User).join(Address, User.id==Address.user_id) The above form may also use a relationship-bound attribute as the ON clause as well:: q = session.query(User).join(Address, User.addresses) The above syntax can be useful for the case where we wish to join to an alias of a particular target entity. If we wanted to join to ``Address`` twice, it could be achieved using two aliases set up using the :func:`~sqlalchemy.orm.aliased` function:: a1 = aliased(Address) a2 = aliased(Address) q = session.query(User).\ join(a1, User.addresses).\ join(a2, User.addresses).\ filter(a1.email_address=='ed@foo.com').\ filter(a2.email_address=='ed@bar.com') The relationship-bound calling form can also specify a target entity using the :meth:`_orm.PropComparator.of_type` method; a query equivalent to the one above would be:: a1 = aliased(Address) a2 = aliased(Address) q = session.query(User).\ join(User.addresses.of_type(a1)).\ join(User.addresses.of_type(a2)).\ filter(a1.email_address == 'ed@foo.com').\ filter(a2.email_address == 'ed@bar.com') **Augmenting Built-in ON Clauses** As a substitute for providing a full custom ON condition for an existing relationship, the :meth:`_orm.PropComparator.and_` function may be applied to a relationship attribute to augment additional criteria into the ON clause; the additional criteria will be combined with the default criteria using AND:: q = session.query(User).join( User.addresses.and_(Address.email_address != 'foo@bar.com') ) .. versionadded:: 1.4 **Joining to Tables and Subqueries** The target of a join may also be any table or SELECT statement, which may be related to a target entity or not. Use the appropriate ``.subquery()`` method in order to make a subquery out of a query:: subq = session.query(Address).\ filter(Address.email_address == 'ed@foo.com').\ subquery() q = session.query(User).join( subq, User.id == subq.c.user_id ) Joining to a subquery in terms of a specific relationship and/or target entity may be achieved by linking the subquery to the entity using :func:`_orm.aliased`:: subq = session.query(Address).\ filter(Address.email_address == 'ed@foo.com').\ subquery() address_subq = aliased(Address, subq) q = session.query(User).join( User.addresses.of_type(address_subq) ) **Controlling what to Join From** In cases where the left side of the current state of :class:`_query.Query` is not in line with what we want to join from, the :meth:`_query.Query.select_from` method may be used:: q = session.query(Address).select_from(User).\ join(User.addresses).\ filter(User.name == 'ed') Which will produce SQL similar to:: SELECT address.* FROM user JOIN address ON user.id=address.user_id WHERE user.name = :name_1 **Legacy Features of Query.join()** .. deprecated:: 1.4 The following features are deprecated and will be removed in SQLAlchemy 2.0. The :meth:`_query.Query.join` method currently supports several usage patterns and arguments that are considered to be legacy as of SQLAlchemy 1.3. A deprecation path will follow in the 1.4 series for the following features: * Joining on relationship names rather than attributes:: session.query(User).join("addresses") **Why it's legacy**: the string name does not provide enough context for :meth:`_query.Query.join` to always know what is desired, notably in that there is no indication of what the left side of the join should be. This gives rise to flags like ``from_joinpoint`` as well as the ability to place several join clauses in a single :meth:`_query.Query.join` call which don't solve the problem fully while also adding new calling styles that are unnecessary and expensive to accommodate internally. **Modern calling pattern**: Use the actual relationship, e.g. ``User.addresses`` in the above case:: session.query(User).join(User.addresses) * Automatic aliasing with the ``aliased=True`` flag:: session.query(Node).join(Node.children, aliased=True).\ filter(Node.name == 'some name') **Why it's legacy**: the automatic aliasing feature of :class:`_query.Query` is intensely complicated, both in its internal implementation as well as in its observed behavior, and is almost never used. It is difficult to know upon inspection where and when its aliasing of a target entity, ``Node`` in the above case, will be applied and when it won't, and additionally the feature has to use very elaborate heuristics to achieve this implicit behavior. **Modern calling pattern**: Use the :func:`_orm.aliased` construct explicitly:: from sqlalchemy.orm import aliased n1 = aliased(Node) session.query(Node).join(Node.children.of_type(n1)).\ filter(n1.name == 'some name') * Multiple joins in one call:: session.query(User).join("orders", "items") session.query(User).join(User.orders, Order.items) session.query(User).join( (Order, User.orders), (Item, Item.order_id == Order.id) ) session.query(User).join(Order, Item) # ... and several more forms actually **Why it's legacy**: being able to chain multiple ON clauses in one call to :meth:`_query.Query.join` is yet another attempt to solve the problem of being able to specify what entity to join from, and is the source of a large variety of potential calling patterns that are internally expensive and complicated to parse and accommodate. **Modern calling pattern**: Use relationship-bound attributes or SQL-oriented ON clauses within separate calls, so that each call to :meth:`_query.Query.join` knows what the left side should be:: session.query(User).join(User.orders).join( Item, Item.order_id == Order.id) :param \*props: Incoming arguments for :meth:`_query.Query.join`, the props collection in modern use should be considered to be a one or two argument form, either as a single "target" entity or ORM attribute-bound relationship, or as a target entity plus an "on clause" which may be a SQL expression or ORM attribute-bound relationship. :param isouter=False: If True, the join used will be a left outer join, just as if the :meth:`_query.Query.outerjoin` method were called. :param full=False: render FULL OUTER JOIN; implies ``isouter``. .. versionadded:: 1.1 :param from_joinpoint=False: When using ``aliased=True``, a setting of True here will cause the join to be from the most recent joined target, rather than starting back from the original FROM clauses of the query. .. note:: This flag is considered legacy. :param aliased=False: If True, indicate that the JOIN target should be anonymously aliased. Subsequent calls to :meth:`_query.Query.filter` and similar will adapt the incoming criterion to the target alias, until :meth:`_query.Query.reset_joinpoint` is called. .. note:: This flag is considered legacy. .. seealso:: :ref:`ormtutorial_joins` in the ORM tutorial. :ref:`inheritance_toplevel` for details on how :meth:`_query.Query.join` is used for inheritance relationships. :func:`_orm.join` - a standalone ORM-level join function, used internally by :meth:`_query.Query.join`, which in previous SQLAlchemy versions was the primary ORM-level joining interface. rFfrom_joinpointisouterfullz~The ``aliased`` and ``from_joinpoint`` keyword arguments to Query.join() are deprecated and will be removed in SQLAlchemy 2.0.zunknown arguments: %sz, NrrzIQuery.join() will no longer accept tuples as arguments in SQLAlchemy 2.0.c3&# UHo4v M g7frAr5rH_ss r<rJQuery.join..S s%>gegc3&# UHo4v M g7frAr5rs r<rJr_ s6gegrrrc 3># UHup[R"[RUSSTS9[ U5S:Xa'[R"[R USSS9OSSTTUS:aSOTTTR S.4v M g7f)rT)legacyrJrrrN)rrrrr)rrMrJoinTargetRoler] OnClauseRoler)rHirmrrrrr:s r<rJrw s 0--  ((G*. t9> $$U%7%7aN &&./!ed *.*B*B  .-sB B zPassing a chain of multiple join conditions to Query.join() is deprecated and will be removed in SQLAlchemy 2.0. Please use individual join() calls per relationship.r)rrwarn_deprecated_20 TypeErrorjoinsortedrrrVrir Selectabletypertypes FunctionTyper ColumnElementstrrPropComparatorrrrr r] ClauseElementrr enumeraterr)r:targetpropsronclauser_props_singlerm joins_to_addrrrrs` @@@@r<r Query.joins,T JJy% ( JJ' / JJy% ( JJvu % 2 .$ n  # #%  '$))F6N*CC  '+D $'+D $ $Qxqrf $ $H(*:fe3L3Li[F)) && **--&& ()FFG E)dE**++7 %>g%>> G"$q'C1J1J+KLL $Qa1MM$'NN4(#*$ 6g66 '+'D'D'FD $  # ## #Dt9>G "$q':+C+CDD ++Q-t/G/GH a #  "  0%V,1  6 | q  # #G    L0  /6k s;A-M#c8SUS'UR"U/UQ70UD6$)zCreate a left outer join against this ``Query`` object's criterion and apply generatively, returning the newly resulting ``Query``. Usage is the same as the ``join()`` method. Tr)r)r:r*r+rs r< outerjoinQuery.outerjoin s'!yyy2%2622r?c SUlSUlg)a#Return a new :class:`.Query`, where the "join point" has been reset back to the base FROM entities of the query. This method is usually used in conjunction with the ``aliased=True`` feature of the :meth:`~.Query.join` method. See the example in :meth:`~.Query.join` for how this is used. N)rrrs r<reset_joinpointQuery.reset_joinpoint s$( #' r?c(URUS5 g)a`Set the FROM clause of this :class:`.Query` explicitly. :meth:`.Query.select_from` is often used in conjunction with :meth:`.Query.join` in order to control which entity is selected from on the "left" side of the join. The entity or selectable object here effectively replaces the "left edge" of any calls to :meth:`~.Query.join`, when no joinpoint is otherwise established - usually, the default "join point" is the leftmost entity in the :class:`~.Query` object's list of entities to be selected. A typical example:: q = session.query(Address).select_from(User).\ join(User.addresses).\ filter(User.name == 'ed') Which produces SQL equivalent to:: SELECT address.* FROM user JOIN address ON user.id=address.user_id WHERE user.name = :name_1 :param \*from_obj: collection of one or more entities to apply to the FROM clause. Entities can be mapped classes, :class:`.AliasedClass` objects, :class:`.Mapper` objects as well as core :class:`.FromClause` elements like subqueries. .. versionchanged:: 0.9 This method no longer applies the given FROM object to be the selectable from which matching entities select from; the :meth:`.select_entity_from` method now accomplishes this. See that method for a description of this behavior. .. seealso:: :meth:`~.Query.join` :meth:`.Query.select_entity_from` FN)ror:from_objs r< select_fromQuery.select_from s^ h.r?z%:meth:`_orm.Query.select_entity_from`z.Use the :func:`_orm.aliased` construct insteadcXURU/S5 U=RSS0- slg)aDSet the FROM clause of this :class:`_query.Query` to a core selectable, applying it as a replacement FROM clause for corresponding mapped entities. The :meth:`_query.Query.select_entity_from` method supplies an alternative approach to the use case of applying an :func:`.aliased` construct explicitly throughout a query. Instead of referring to the :func:`.aliased` construct explicitly, :meth:`_query.Query.select_entity_from` automatically *adapts* all occurrences of the entity to the target selectable. Given a case for :func:`.aliased` such as selecting ``User`` objects from a SELECT statement:: select_stmt = select(User).where(User.id == 7) user_alias = aliased(User, select_stmt) q = session.query(user_alias).\ filter(user_alias.name == 'ed') Above, we apply the ``user_alias`` object explicitly throughout the query. When it's not feasible for ``user_alias`` to be referenced explicitly in many places, :meth:`_query.Query.select_entity_from` may be used at the start of the query to adapt the existing ``User`` entity:: q = session.query(User).\ select_entity_from(select_stmt.subquery()).\ filter(User.name == 'ed') Above, the generated SQL will show that the ``User`` entity is adapted to our statement, even in the case of the WHERE clause: .. sourcecode:: sql SELECT anon_1.id AS anon_1_id, anon_1.name AS anon_1_name FROM (SELECT "user".id AS id, "user".name AS name FROM "user" WHERE "user".id = :id_1) AS anon_1 WHERE anon_1.name = :name_1 The :meth:`_query.Query.select_entity_from` method is similar to the :meth:`_query.Query.select_from` method, in that it sets the FROM clause of the query. The difference is that it additionally applies adaptation to the other parts of the query that refer to the primary entity. If above we had used :meth:`_query.Query.select_from` instead, the SQL generated would have been: .. sourcecode:: sql -- uses plain select_from(), not select_entity_from() SELECT "user".id AS user_id, "user".name AS user_name FROM "user", (SELECT "user".id AS id, "user".name AS name FROM "user" WHERE "user".id = :id_1) AS anon_1 WHERE "user".name = :name_1 To supply textual SQL to the :meth:`_query.Query.select_entity_from` method, we can make use of the :func:`_expression.text` construct. However, the :func:`_expression.text` construct needs to be aligned with the columns of our entity, which is achieved by making use of the :meth:`_expression.TextClause.columns` method:: text_stmt = text("select id, name from user").columns( User.id, User.name).subquery() q = session.query(User).select_entity_from(text_stmt) :meth:`_query.Query.select_entity_from` itself accepts an :func:`.aliased` object, so that the special options of :func:`.aliased` such as :paramref:`.aliased.adapt_on_names` may be used within the scope of the :meth:`_query.Query.select_entity_from` method's adaptation services. Suppose a view ``user_view`` also returns rows from ``user``. If we reflect this view into a :class:`_schema.Table`, this view has no relationship to the :class:`_schema.Table` to which we are mapped, however we can use name matching to select from it:: user_view = Table('user_view', metadata, autoload_with=engine) user_view_alias = aliased( User, user_view, adapt_on_names=True) q = session.query(User).\ select_entity_from(user_view_alias).\ order_by(User.name) .. versionchanged:: 1.1.7 The :meth:`_query.Query.select_entity_from` method now accepts an :func:`.aliased` object as an alternative to a :class:`_expression.FromClause` object. :param from_obj: a :class:`_expression.FromClause` object that will replace the FROM clause of this :class:`_query.Query`. It also may be an instance of :func:`.aliased`. .. seealso:: :meth:`_query.Query.select_from` TrFN)rorhr8s r<select_entity_fromQuery.select_entity_from s.l xj$/ "7!??r?c[R"UUUR(+=(d URR(+S9$)N)allow_negative)orm_util_getitemr8future)r:items r< __getitem__Query.__getitem__` s7   #||+F4<<3F3F/F  r?cv[R"URURX5uUlUlg)a~Computes the "slice" of the :class:`_query.Query` represented by the given indices and returns the resulting :class:`_query.Query`. The start and stop indices behave like the argument to Python's built-in :func:`range` function. This method provides an alternative to using ``LIMIT``/``OFFSET`` to get a slice of the query. For example, :: session.query(User).order_by(User.id).slice(1, 3) renders as .. sourcecode:: sql SELECT users.id AS users_id, users.name AS users_name FROM users ORDER BY users.id LIMIT ? OFFSET ? (2, 1) .. seealso:: :meth:`_query.Query.limit` :meth:`_query.Query.offset` N)r _make_slicerr)r:startstops r<slice Query.sliceg s3B3;2F2F    3 3U3 /D/r?c:[R"U5Ulg)zJApply a ``LIMIT`` to the query and return the newly resulting ``Query``. N)r_offset_or_limit_clauser)r:limits r<rO Query.limit s&==eDr?c:[R"U5Ulg)zLApply an ``OFFSET`` to the query and return the newly resulting ``Query``. N)rrNr)r:offsets r<rR Query.offset s'>>vFr?cxU(a,SUlUR[SU55-UlgSUlg)a]Apply a ``DISTINCT`` to the query and return the newly resulting ``Query``. .. note:: The ORM-level :meth:`.distinct` call includes logic that will automatically add columns from the ORDER BY of the query to the columns clause of the SELECT statement, to satisfy the common need of the database backend that ORDER BY columns be part of the SELECT list when DISTINCT is used. These columns *are not* added to the list of columns actually fetched by the :class:`_query.Query`, however, so would not affect results. The columns are passed through when using the :attr:`_query.Query.statement` accessor, however. .. deprecated:: 2.0 This logic is deprecated and will be removed in SQLAlchemy 2.0. See :ref:`migration_20_query_distinct` for a description of this use case in 2.0. :param \*expr: optional column expressions. When present, the PostgreSQL dialect will render a ``DISTINCT ON ()`` construct. .. deprecated:: 1.4 Using \*expr in other dialects is deprecated and will raise :class:`_exc.CompileError` in a future version. Tc3l# UH*n[R"[RU5v M, g7frA)rrMrByOfRole)rHes r<rJ!Query.distinct.. s':=A   33TrLN)rrri)r:exprs r<r}Query.distinct s>> !DN $ 1 1E:=A:5!D "DNr?c>UR5R5$)aReturn the results represented by this :class:`_query.Query` as a list. This results in an execution of the underlying SQL statement. .. warning:: The :class:`_query.Query` object, when asked to return either a sequence or iterator that consists of full ORM-mapped entities, will **deduplicate entries based on primary key**. See the FAQ for more details. .. seealso:: :ref:`faq_query_deduplicating` )_iterallrs r<r] Query.all s zz|!!r?cV[R"[RXS9nXlg)aExecute the given SELECT statement and return results. This method bypasses all internal statement compilation, and the statement is executed without modification. The statement is typically either a :func:`_expression.text` or :func:`_expression.select` construct, and should return the set of columns appropriate to the entity class represented by this :class:`_query.Query`. .. seealso:: :ref:`orm_tutorial_literal_sql` - usage examples in the ORM tutorial rpN)rrMrSelectStatementRoler)r:rs r<from_statementQuery.from_statement s&($$  % %y $r?cURbUR5R5$URS5R5R5$)aReturn the first result of this ``Query`` or None if the result doesn't contain any row. first() applies a limit of one within the generated SQL, so that only one primary entity row is generated on the server side (note this may consist of multiple result rows if join-loaded collections are present). Calling :meth:`_query.Query.first` results in an execution of the underlying query. .. seealso:: :meth:`_query.Query.one` :meth:`_query.Query.one_or_none` r)rr\firstrOrs r<rd Query.first sC* ?? &::<%%' '::a=&&(..0 0r?c>UR5R5$)a(Return at most one result or raise an exception. Returns ``None`` if the query selects no rows. Raises ``sqlalchemy.orm.exc.MultipleResultsFound`` if multiple object identities are returned, or if multiple rows are returned for a query that returns only scalar values as opposed to full identity-mapped entities. Calling :meth:`_query.Query.one_or_none` results in an execution of the underlying query. .. versionadded:: 1.0.9 Added :meth:`_query.Query.one_or_none` .. seealso:: :meth:`_query.Query.first` :meth:`_query.Query.one` )r\ one_or_noners r<rgQuery.one_or_none s0zz|''))r?c>UR5R5$)aReturn exactly one result or raise an exception. Raises ``sqlalchemy.orm.exc.NoResultFound`` if the query selects no rows. Raises ``sqlalchemy.orm.exc.MultipleResultsFound`` if multiple object identities are returned, or if multiple rows are returned for a query that returns only scalar values as opposed to full identity-mapped entities. Calling :meth:`.one` results in an execution of the underlying query. .. seealso:: :meth:`_query.Query.first` :meth:`_query.Query.one_or_none` )r\oners r<rj Query.one$ s$zz|!!r?cUR5n[U[R5(dU$US$![R a gf=f)aReturn the first element of the first result or None if no rows present. If multiple rows are returned, raises MultipleResultsFound. >>> 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. rN)rjrVr1Sequenceorm_exc NoResultFound)r:rets r<scalar Query.scalar8 sK( ((*Cc?#;#;<< q6M$$  s088AAc## UR5nUHnUv M g![a UR5 ef=f7frA)r\ GeneratorExit _soft_close)r:resultrows r<__iter__Query.__iter__T sC         sA "A>AcURnUR5nURRUUSUR0S9nUR R SS5(aUR5nUR R SS5(a+URR(dUR5nU$)N_sa_orm_load_optionsr:rFfiltered) rrr8executert _attributesrzscalarsr-unique)r:rrrvs r<r\ Query._iter_ s&&( %%  5t7H7HI&     ! !"4e < <^^%F    " ":u 5 5%%00]]_F r?cUR5nUR(a%URXRR5OSn[ URU55$![R a SnN2f=frA)rr8_get_bind_argsget_bindr_UnboundExecutionErrorr&compile)r:rbinds r<__str__ Query.__str__v st&&(  <<##I||/D/DE 9$$T*++++ D s8A$$A=<A=c U"SSU0UD6$)Nrr5r5)r:rrkws r<rQuery._get_bind_args s))b))r?c[USS9$)aReturn metadata about the columns which would be returned by this :class:`_query.Query`. Format is a list of dictionaries:: user_alias = aliased(User, name='user2') q = sess.query(User, User.id, user_alias) # this expression: q.column_descriptions # would return: [ { 'name':'User', 'type':User, 'aliased':False, 'expr':User, 'entity': User }, { 'name':'id', 'type':Integer(), 'aliased':False, 'expr':User.id, 'entity': User }, { 'name':'user2', 'type':User, 'aliased':True, 'expr':user_alias, 'entity': user_alias } ] .. seealso:: This API is available using :term:`2.0 style` queries as well, documented at: * :ref:`queryguide_inspection` * :attr:`.Select.column_descriptions` Trr rs r<column_descriptionsQuery.column_descriptions sb$D66r?cUc[[R"SSS9 URSS9n[UURUR UR UR5n[R"X5nURRSS5(aUR5nURRSS5(aUR5nU$)zXReturn an ORM result given a :class:`_engine.CursorResult` and :class:`.QueryContext`. zUsing the Query.instances() method without a context is deprecated and will be disallowed in a future release. Please make use of :meth:`_query.Query.from_statement` for linking ORM results to arbitrary select constructs.r)versionFrrr})rwarn_deprecatedrrrrr8rtr instancesrrzrr)r: result_proxycontext compile_statervs r<rQuery.instances s ?  J  !//e/DM"''  !! G""<9    ! !"4e < <^^%F    ! !*e 4 4]]_F r?z:meth:`_orm.Query.merge_result`zJThe method is superseded by the :func:`_orm.merge_frozen_result` function.)rr1enable_warningsc0[R"XU5$)aMerge a result into this :class:`_query.Query` object's Session. Given an iterator returned by a :class:`_query.Query` of the same structure as this one, return an identical iterator of results, with all mapped instances merged into the session using :meth:`.Session.merge`. This is an optimized method which will merge all mapped instances, preserving the structure of the result rows and unmapped columns with less method overhead than that of calling :meth:`.Session.merge` explicitly for each value. The structure of the results is determined based on the column list of this :class:`_query.Query` - if these do not correspond, unchecked errors will occur. The 'load' argument is the same as that of :meth:`.Session.merge`. For an example of how :meth:`_query.Query.merge_result` is used, see the source code for the example :ref:`examples_caching`, where :meth:`_query.Query.merge_result` is used to efficiently restore state from a cache back into a target :class:`.Session`. )r merge_result)r:iteratorloads r<rQuery.merge_result sB##DD99r?c6URS5R[R"S55R [ 5R RS5nUR5nUbURU5n[R"U5$)aA convenience method that turns a query into an EXISTS subquery of the form EXISTS (SELECT 1 FROM ... WHERE ...). e.g.:: q = session.query(User).filter(User.name == 'fred') session.query(q.exists()) Producing SQL similar to:: SELECT EXISTS ( SELECT 1 FROM users WHERE users.name = :name_1 ) AS anon_1 The EXISTS construct is usually used in the WHERE clause:: session.query(User.id).filter(q.exists()).scalar() Note that some databases such as SQL Server don't allow an EXISTS expression to be present in the columns clause of a SELECT. To select a simple boolean value based on the exists as a WHERE, use :func:`.literal`:: from sqlalchemy import literal session.query(literal(True)).filter(q.exists()).scalar() F1r) rrrliteral_columnrr-rwith_only_columnsrZr:exists)r:innerezeros r<r Query.exists s}J  " "5 ) [++C0 1 _; < Y((+ ..0  %%e,Ezz%  r?c[RR[R"S55nUR U5R S5R 5$)aReturn a count of rows this the SQL formed by this :class:`Query` would return. This generates the SQL for this Query as follows:: SELECT count(1) AS count_1 FROM ( SELECT ) AS anon_1 The above SQL returns a single row, which is the aggregate value of the count function; the :meth:`_query.Query.count` method then returns that single integer value. .. warning:: It is important to note that the value returned by count() is **not the same as the number of ORM objects that this Query would return from a method such as the .all() method**. The :class:`_query.Query` object, when asked to return full entities, will **deduplicate entries based on primary key**, meaning if the same primary key value would appear in the results more than once, only one object of that primary key would be present. This does not apply to a query that is against individual columns. .. seealso:: :ref:`faq_query_deduplicating` :ref:`orm_tutorial_query_returning` For fine grained control over specific columns to count, to skip the usage of a subquery or otherwise control of the FROM clause, or to use other aggregate functions, use :attr:`~sqlalchemy.sql.expression.func` expressions in conjunction with :meth:`~.Session.query`, i.e.:: from sqlalchemy import func # count User records, without # using a subquery. session.query(func.count(User.id)) # return count of user "id" grouped # by "name" session.query(func.count(User.id)).\ group_by(User.name) from sqlalchemy import distinct # count distinct "name" values session.query(func.count(distinct(User.name))) *F)rfuncr.rryrrq)r:cols r<r. Query.count0 sEnhhnnS//45s#55e<CCEEr?c[U5nURR(aEURRH+nU"URU5nUbXBlURnM- [R "UR 6nURUlURRUURSU0S9nXbl URRRU5 UR5 UR$)aPPerform a DELETE with an arbitrary WHERE clause. Deletes rows matched by this query from the database. E.g.:: sess.query(User).filter(User.age == 25).\ delete(synchronize_session=False) sess.query(User).filter(User.age == 25).\ delete(synchronize_session='evaluate') .. warning:: See the section :ref:`orm_expression_update_delete` for important caveats and warnings, including limitations when using bulk UPDATE and DELETE with mapper inheritance configurations. :param synchronize_session: chooses the strategy to update the attributes on objects in the session. See the section :ref:`orm_expression_update_delete` for a discussion of these strategies. :return: the count of rows matched as returned by the database's "row count" feature. .. seealso:: :ref:`orm_expression_update_delete` synchronize_sessionr|) BulkDeleterbefore_compile_deletequeryrdeleterOrr8r~rrvafter_bulk_deletecloserowcount)r:rbulk_delrrdelete_rvs r<r Query.deletej sBd# == . .mm99x~~x8 (%.N~~ :**d//0"&"6"6%%  LL46IJ&  ! //9 r?cU=(d 0n[XU5nURR(aGURRH!nU"URU5nUcMXdlM# URn[R "UR 6nURSS5nU(aUR"U6nOURU5nU(aUR"S0UD6nURUl URRUURSU0S9n XlURRR!U5 U R#5 U R$$)aPerform an UPDATE with an arbitrary WHERE clause. Updates rows matched by this query in the database. E.g.:: sess.query(User).filter(User.age == 25).\ update({User.age: User.age - 10}, synchronize_session=False) sess.query(User).filter(User.age == 25).\ update({"age": User.age - 10}, synchronize_session='evaluate') .. warning:: See the section :ref:`orm_expression_update_delete` for important caveats and warnings, including limitations when using arbitrary UPDATE and DELETE with mapper inheritance configurations. :param values: a dictionary with attributes names, or alternatively mapped attributes or SQL expressions, as keys, and literal values or sql expressions as values. If :ref:`parameter-ordered mode ` is desired, the values can be passed as a list of 2-tuples; this requires that the :paramref:`~sqlalchemy.sql.expression.update.preserve_parameter_order` flag is passed to the :paramref:`.Query.update.update_args` dictionary as well. :param synchronize_session: chooses the strategy to update the attributes on objects in the session. See the section :ref:`orm_expression_update_delete` for a discussion of these strategies. :param update_args: Optional dictionary, if present will be passed to the underlying :func:`_expression.update` construct as the ``**kw`` for the object. May be used to pass dialect-specific arguments such as ``mysql_limit``, as well as other special arguments such as :paramref:`~sqlalchemy.sql.expression.update.preserve_parameter_order`. :return: the count of rows matched as returned by the database's "row count" feature. .. seealso:: :ref:`orm_expression_update_delete` preserve_parameter_orderFrr|r5) BulkUpdaterbefore_compile_updaterrrrOrordered_valuesrDwith_dialect_optionsrr8r~rrvafter_bulk_updaterr) r:rDr update_argsbulk_udrrupdpporvs r<r Query.update s*f"'R T;7 == . .mm99w}}g6 ($-M:==Djj$++,oo8%@ $$f-C**V$C **9[9C"22%%  LL46IJ&    //8 r?c UR"SSU0UD6nXRR:Xde[R"US5nUR US5$)ajCreate an out-of-compiler ORMCompileState object. The ORMCompileState object is normally created directly as a result of the SQLCompiler.process() method being handed a Select() or FromStatement() object that uses the "orm" plugin. This method provides a means of creating this ORMCompileState object directly without using the compiler. This method is used only for deprecated cases, which include the .from_self() method for a Query that has multiple levels of .from_self() in use, as well as the instances() method. It is also used within the test suite to generate ORMCompileState objects for test purposes. rrNr5)rrhrr_get_plugin_class_for_plugincreate_for_statement)r:rrrcompile_state_clss r<rQuery._compile_state sa"!!D DD 5 5 D DDDD ,HH % !55dDAAr?cURUS9n[UURURURUR 5nU$)Nr)rrrrr8rt)r:rrrs r<_compile_contextQuery._compile_context sI++-+H    # # LL LL     r?)rr rMrhrNrrrrr;rjrrrrrrrrrCrOrrr8rA)TT)NNNNN)T)FT)NFF)NN)FFNFF)evaluate)rN)F)re __module__ __qualname____firstlineno____doc__rrrrrrrrr;rNrMrj _setup_joinsrr rrrdefault_compile_optionsrhrdefault_load_optionsrtr EMPTY_DICTrrrrrrBrCr=rEr9rZrbror$rvrrrr~rrrrirrrrrrrrr deprecatedrrrrrrrr deprecated_20r apply_labelsrrrrr$rrr/rzr3rAr"rQrVrr\preload_modulerrsrvr{ryrrrD_valuesrrrrr9rrr:r8rrrgmemoized_propertyrrr|rrrrrrrrrr rr2r5r:r=rErKrOrRr}r]rardrgrjrqrxr\rrrrrrr.rrrr__static_attributes__r5r?r<r2r2LsR.OMNILOJOIL)L "&>>44D8LooGJ ))+%>  ( A #:: L& =+    < ))V".d $"L9 v C __  0 &  & I ) )  = =  2??"%% L D  DL !!!F((*     9 9,- -H ?C( . ( T330  M RB  RBh  33 33: 5 5 : :;; (L  786P9  6Pp  2 (n*n*` >>EE: __  I   G __  :%%6   __  G (  (##8& '+H+HZ  = = ~22&'(*:;%1<%1N ($T%%N(*:;.0<.0`(*:;'0<'0R(*:; < .N%2N66:470 (*:;r7<r7h 3() (* (,--/.-/^ /D,-q@.  q@f ()! *! F()E*E()G*G()#"*#"J"$,-$.$.14*4"(8 . ,*0707d D )5 ::8/!b8Ft5nQfB< r?r2c(^\rSrSrSrSr\Rr\Rr Sr S\ R4S\ R4/\R -r\S\ R$4/-rSrS rS r\S 5rS rS rU4Sjr\S5r\S5rSrU=r$)ri z`Core construct that represents a load of ORM objects from a finished select or text construct. orm_from_statementNrOrYrhc [R"U5Vs/sH(n[R"[R UUSS9PM* snUlX lgs snfrH)rrLrrMrrNrOrY)r:r;rYrPs r<r=FromStatement.__init__6 sZ||H- .   ''&*!   .   s/AcUR$rArrs r<rFromStatement.get_label_styleB s   r?cJ[URRU55$rA)r/rYr)r: label_styles r<rFromStatement.set_label_styleE s!& LL ( ( 5  r?c.URR$rA)rYrrs r<rFromStatement._label_styleJ s||(((r?c UR"X40UD6nUR(+nU(aX1lUR"UR40UD6$)zprovide a fixed _compiler_dispatch method. This is roughly similar to using the sqlalchemy.ext.compiler ``@compiles`` extension. )_compile_state_factorystackrprocessr)r:compilerrrtoplevels r<_compiler_dispatch FromStatement._compiler_dispatchN sJ33DIbI ~~% %2 " 7 7>2>>r?cU$rAr5rs r<_ensure_disambiguated_names)FromStatement._ensure_disambiguated_names` s r?c+># [RRSUR55HnUv M [[ U]"S0UD6HnUv M g7f)Nc38# UHoRv M g7frA) _from_objects)rHrYs r<rJ-FromStatement.get_children..d s2 1Bg ! !1Bsr5) itertoolschain from_iterablerOsuperr get_children)r:rrmrfs r<rFromStatement.get_childrenc sZOO112 151B1B2  DJ -;AbADJBsAAchURR(aURR$S$rA)rYis_dml _returningrs r<rFromStatement._returningk s#*.,,*=*=t||&&G4Gr?chURR(aURR$S$rA)rYr_inliners r<rFromStatement._inlineo s#'+||':':t||##DDr?)rOrY) rerrrr__visit_name__rrrhrrr;r0dp_clauseelement_listdp_clauseelementr%_executable_traverse_internals_traverse_internalsdp_has_cache_key_cache_key_traversalr=rrrirrrrrrr __classcell__rfs@r<rr s *N3KK9NNO *@@A %667 112 / .??@2 ! ))?$HHEEr?rcP\rSrSr\R "SS5S5rSrSrSr g) AliasOptionit rzThe :class:`.AliasOption` is not necessary for entities to be matched up to a query that is established via :meth:`.Query.from_statement` and now does nothing.cg)zwReturn a :class:`.MapperOption` that will indicate to the :class:`_query.Query` that the main table has been aliased. Nr5)r:rs r<r=AliasOption.__init__u sr?FcgrAr5)r:rs r<process_compile_state!AliasOption.process_compile_state s r?r5N) rerrrrrr= inherit_cacherrr5r?r<r r t s2 __  B    M r?r c4\rSrSrSrSrSr\S5rSr g)BulkUDi zjState used for the orm.Query version of update() / delete(). This object is now specific to Query only. cURS5UlUR5 URR5Ulg)NF)rr_validate_query_staterZr>)r:rs r<r=BulkUD.__init__ s4,,U3  ""$jj::< r?c SSS[R4SSS[R4SSS[R4SS S[R4S S S [R4S SS[R4SSS[R44HCupp4U"[URU5U5(aM*[ R "SU<S35e g)Nrzlimit()rzoffset()rz order_by()r5rz group_by()rz distinct()Frjz2join(), outerjoin(), select_from(), or from_self()rz1Can't call Query.update() or Query.delete() when z has been called)operatoris_eqgetattrrr_r`)r:rranotsetops r<rBulkUD._validate_query_state s ix|| < z4 > ,HKK @ ,HKK @ ,x|| <D  &D  + &DF&gdjj$/880019<)+ r?c.URR$rA)rr8rs r<r8BulkUD.session szz!!!r?)r>rN) rerrrrr=rrir8rr5r?r<rr s% = 4""r?rc,^\rSrSrSrU4SjrSrU=r$)ri zBulkUD which handles UPDATEs.cD>[[U] U5 X lX0lgrA)rrr=rD update_kwargs)r:rrDr%rfs r<r=BulkUpdate.__init__ s j$(/ *r?)r%rD)rerrrrr=rr r s@r<rr s'++r?rc\rSrSrSrSrg)ri zBulkUD which handles DELETEs.r5N)rerrrrrr5r?r<rr s'r?r)Frrrr#rrnrrrrAbaserrr r r r rrrrrrrrrr_rrrrrrrrr rr!sql.annotationr"sql.baser#r$r%sql.selectabler&r'r(r)r*r+r,r-r.r/ sql.visitorsr0r1__all___self_inspects class_loggerr2r LoaderOptionr objectrrrr5r?r<r3s7  )92+$1!,""5,"!40)+%((;'4," . N3  N3N3bfRENJ REj *)) (("V("V++((r?