+h.{ dZddlZddlZddlZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddlm!Z!ddlm"Z"ddlm#Z#ddl$m%Z%ddl&m'Z'gd Z(ejRZ* e*e _*d!Z+Gd"d#e,Z-ej\d$Z/ej\d%Z0ej\d&Z1ej\d'Z2ej\d(Z3Gd)d*ejhZ5Gd+d,eZ6Gd-d.e-Z7Gd/d0e-Z8d1Z9d2Z:d3Z;d4Z<ejzZ>y)5z1Provides the Session class and related utilities.N) attributes)context)exc)identity)loading) persistence)querystate)_class_to_mapper) _none_set) _state_mapper) instance_str) object_mapper) object_state) state_str)UOWTransaction)engine)sql)util)TransactionalContext)inspect) coercions)dml)roles)visitors) CompileState)LABEL_STYLE_TABLENAME_PLUS_COL)SessionSessionTransaction sessionmakerORMExecuteStateclose_all_sessionsmake_transientmake_transient_to_detachedobject_sessionc|jS)z[Given an :class:`.InstanceState`, return the :class:`.Session` associated, if any. sessionr s I/var/www/html/venv/lib/python3.12/site-packages/sqlalchemy/orm/session.py_state_sessionr-=s ==ceZdZdZeej dddZeejddZ edZ y) _SessionClassMethodszBClass-level methods for :class:`.Session`, :class:`.sessionmaker`.z1.3zThe :meth:`.Session.close_all` method is deprecated and will be removed in a future release. Please refer to :func:`.session.close_all_sessions`.cty)zClose *all* sessions in memory.N)r%)clss r, close_allz_SessionClassMethods.close_allGs  r.zsqlalchemy.orm.utilcTtjjj|i|S)zZReturn an identity key. This is an alias of :func:`.util.identity_key`. )r preloadedorm_util identity_key)r2argskwargss r,r7z!_SessionClassMethods.identity_keySs$~~&&33TDVDDr.ct|S)zxReturn the :class:`.Session` to which an object belongs. This is an alias of :func:`.object_session`. )r()r2instances r,r(z#_SessionClassMethods.object_session]sh''r.N) __name__ __module__ __qualname____doc__ classmethodr deprecatedr3preload_moduler7r(r.r,r0r0DsrLT__  /   T./E0E((r.r0ACTIVEPREPARED COMMITTEDDEACTIVECLOSEDc,eZdZdZdZdZdZ ddZedZ edZ ed Z ed Z ed Z ed Zed ZedZdZdZedZedZedZedZedZedZedZy)r$a8Represents a call to the :meth:`_orm.Session.execute` method, as passed to the :meth:`.SessionEvents.do_orm_execute` event hook. .. versionadded:: 1.4 .. seealso:: :ref:`session_execute_events` - top level documentation on how to use :meth:`_orm.SessionEvents.do_orm_execute` ) r+ statement parametersexecution_optionslocal_execution_optionsbind_arguments_compile_state_cls_starting_event_idx _events_todo_update_execution_optionsc||_||_||_||_|jj ||_||_||_t||_ yN) r+rJrKrM_execution_optionsunionrLrNrOlistrQ)selfr+rJrKrLrNcompile_state_cls events_todos r,__init__zORMExecuteState.__init__s\ "$'8$!*!=!=!C!C " -"3 -r.c:|j|jdzdS)Nr)rQrPrXs r,_remaining_eventsz!ORMExecuteState._remaining_eventss!  !9!9A!=!?@@r.Nc`| |j}t|j}|r|j|d|d<|r't|j}|j|n |j}|j }|r|j |}|jj|||||S)a+Execute the statement represented by this :class:`.ORMExecuteState`, without re-invoking events that have already proceeded. This method essentially performs a re-entrant execution of the current statement for which the :meth:`.SessionEvents.do_orm_execute` event is being currently invoked. The use case for this is for event handlers that want to override how the ultimate :class:`_engine.Result` object is returned, such as for schemes that retrieve results from an offline cache or which concatenate results from multiple executions. When the :class:`_engine.Result` object is returned by the actual handler function within :meth:`_orm.SessionEvents.do_orm_execute` and is propagated to the calling :meth:`_orm.Session.execute` method, the remainder of the :meth:`_orm.Session.execute` method is preempted and the :class:`_engine.Result` object is returned to the caller of :meth:`_orm.Session.execute` immediately. :param statement: optional statement to be invoked, in place of the statement currently represented by :attr:`.ORMExecuteState.statement`. :param params: optional dictionary of parameters which will be merged into the existing :attr:`.ORMExecuteState.parameters` of this :class:`.ORMExecuteState`. :param execution_options: optional dictionary of execution options will be merged into the existing :attr:`.ORMExecuteState.execution_options` of this :class:`.ORMExecuteState`. :param bind_arguments: optional dictionary of bind_arguments which will be merged amongst the current :attr:`.ORMExecuteState.bind_arguments` of this :class:`.ORMExecuteState`. :return: a :class:`_engine.Result` object with ORM-level results. .. seealso:: :ref:`do_orm_execute_re_executing` - background and examples on the appropriate usage of :meth:`_orm.ORMExecuteState.invoke_statement`. T_sa_skip_events)_parent_execute_state) rJdictrNupdaterKrMrVr+execute)rXrJparamsrLrN_bind_arguments_paramsrUs r,invoke_statementz ORMExecuteState.invoke_statementsl  It223   " "> 2-1)* 4??+G NN6 "ooG!99 !3!9!9:K!L ||##    "& $  r.c:|jjddS)aReturn the :class:`_orm.Mapper` that is the primary "bind" mapper. For an :class:`_orm.ORMExecuteState` object invoking an ORM statement, that is, the :attr:`_orm.ORMExecuteState.is_orm_statement` attribute is ``True``, this attribute will return the :class:`_orm.Mapper` that is considered to be the "primary" mapper of the statement. The term "bind mapper" refers to the fact that a :class:`_orm.Session` object may be "bound" to multiple :class:`_engine.Engine` objects keyed to mapped classes, and the "bind mapper" determines which of those :class:`_engine.Engine` objects would be selected. For a statement that is invoked against a single mapped class, :attr:`_orm.ORMExecuteState.bind_mapper` is intended to be a reliable way of getting this mapper. .. versionadded:: 1.4.0b2 .. seealso:: :attr:`_orm.ORMExecuteState.all_mappers` mapperN)rNgetr]s r, bind_mapperzORMExecuteState.bind_mappers4""&&x66r.c|jsgS|jrg}t}|jjD]l}|d}|s t |d}|s|j s(|j |vs7|j|j |j|j n|S|js |jr |jgSgS)aReturn a sequence of all :class:`_orm.Mapper` objects that are involved at the top level of this statement. By "top level" we mean those :class:`_orm.Mapper` objects that would be represented in the result set rows for a :func:`_sql.select` query, or for a :func:`_dml.update` or :func:`_dml.delete` query, the mapper that is the main subject of the UPDATE or DELETE. .. versionadded:: 1.4.0b2 .. seealso:: :attr:`_orm.ORMExecuteState.bind_mapper` entityF)raiseerr) is_orm_statement is_selectsetrJcolumn_descriptionsrrjaddappend is_update is_deleterl)rXresultseendentinsps r, all_mapperszORMExecuteState.all_mappers s&$$I ^^F5D^^77 3k"37D  40G- dkk2  3M ^^t~~$$% %Ir.c|jduS)areturn True if the operation is an ORM statement. This indicates that the select(), update(), or delete() being invoked contains ORM entities as subjects. For a statement that does not have ORM entities and instead refers only to :class:`.Table` metadata, it is invoked as a Core SQL statement and no ORM-level automation takes place. N)rOr]s r,rpz ORMExecuteState.is_orm_statement2s&&d22r.c.|jjS)z*return True if this is a SELECT operation.)rJrqr]s r,rqzORMExecuteState.is_select?s~~'''r.c^|jjxr|jjS)z+return True if this is an INSERT operation.)rJis_dml is_insertr]s r,rzORMExecuteState.is_insertD#~~$$A)A)AAr.c^|jjxr|jjS)z+return True if this is an UPDATE operation.)rJrrvr]s r,rvzORMExecuteState.is_updateIrr.c^|jjxr|jjS)z*return True if this is a DELETE operation.)rJrrwr]s r,rwzORMExecuteState.is_deleteNrr.cjt|jtjtjfSrT) isinstancerJrUpdateDeleter]s r,_is_crudzORMExecuteState._is_crudSs $..3::szz*BCCr.c D|jj||_yrT)rMrVrXoptss r,update_execution_optionsz(ORMExecuteState.update_execution_optionsWs'+'C'C'I'I$'O$r.c|jsy |jj}|j t j jr|Sy#t$rYywxYwrT)rqrJ_compile_optionsAttributeErrorrrORMCompileStatedefault_compile_optionsrs r,_orm_compile_optionsz$ORMExecuteState._orm_compile_options[sV~~ >>22D ??722JJ KK   sA AAc.|jjS)aAn :class:`.InstanceState` that is using this statement execution for a lazy load operation. The primary rationale for this attribute is to support the horizontal sharding extension, where it is available within specific query execution time hooks created by this extension. To that end, the attribute is only intended to be meaningful at **query execution time**, and importantly not any time prior to that, including query compilation time. ) load_options_lazy_loaded_fromr]s r,lazy_loaded_fromz ORMExecuteState.lazy_loaded_fromgs  222r.c@|j}| |jSy)zReturn the :class:`.PathRegistry` for the current load path. This object represents the "path" in a query along relationships when a particular object or collection is being loaded. N)r _current_pathrs r,loader_strategy_pathz$ORMExecuteState.loader_strategy_pathvs'((*  %% %r.cF|j}|duxr |jS)aqReturn True if the operation is refreshing column-oriented attributes on an existing ORM object. This occurs during operations such as :meth:`_orm.Session.refresh`, as well as when an attribute deferred by :func:`_orm.defer` is being loaded, or an attribute that was expired either directly by :meth:`_orm.Session.expire` or via a commit operation is being loaded. Handlers will very likely not want to add any options to queries when such an operation is occurring as the query should be a straight primary key fetch which should not have any additional WHERE criteria, and loader options travelling with the instance will have already been added to the query. .. versionadded:: 1.4.0b2 .. seealso:: :attr:`_orm.ORMExecuteState.is_relationship_load` N)r_for_refresh_staters r,is_column_loadzORMExecuteState.is_column_loads(0((*4;D$;$;;r.cf|j}|y|j}|duxr |j S)azReturn True if this load is loading objects on behalf of a relationship. This means, the loader in effect is either a LazyLoader, SelectInLoader, SubqueryLoader, or similar, and the entire SELECT statement being emitted is on behalf of a relationship load. Handlers will very likely not want to add any options to queries when such an operation is occurring, as loader options are already capable of being propagated to relationship loaders and should be already present. .. seealso:: :attr:`_orm.ORMExecuteState.is_column_load` NF)rris_root)rXrpaths r,is_relationship_loadz$ORMExecuteState.is_relationship_loads<(((* <((44 $44r.c|jstjd|jj dt j jS)z=Return the load_options that will be used for this execution.zRThis ORM execution is not against a SELECT statement so there are no load options._sa_orm_load_options)rqsa_excInvalidRequestErrorrLrkr QueryContextdefault_load_optionsr]s r,rzORMExecuteState.load_optionssO~~,,0 %%)) "G$8$8$M$M  r.c|jstjd|jj dt j jS)zNReturn the update_delete_options that will be used for this execution.z_This ORM execution is not against an UPDATE or DELETE statement so there are no update options._sa_orm_update_options)rrrrLrkr BulkUDCompileStatedefault_update_optionsr]s r,update_delete_optionsz%ORMExecuteState.update_delete_optionssP }},,< %%)) $  * * A A  r.c|jjDcgc]}|js|js|c}Scc}w)zzThe sequence of :class:`.UserDefinedOptions` that have been associated with the statement being invoked. )rJ _with_options_is_compile_state_is_legacy_option)rXopts r,user_defined_optionsz$ORMExecuteState.user_defined_optionss?~~33 ((1F1F    s!=)NNNN)r<r=r>r? __slots__r[r^rhpropertyrlr}rprqrrvrwrrrrrrrrrrrCr.r,r$r$osn  I.*A  N `776""H 3 3((BBBBBBDDP  3 3  <<4552            r.r$ceZdZdZdZ ddZedZdZ edZ ddZ edZ dd Z dd Z dd Zdd Zdd ZdZdZdZdZddZddZddZdZdZdZdZy)r"aA :class:`.Session`-level transaction. :class:`.SessionTransaction` is produced from the :meth:`_orm.Session.begin` and :meth:`_orm.Session.begin_nested` methods. It's largely an internal object that in modern use provides a context manager for session transactions. Documentation on interacting with :class:`_orm.SessionTransaction` is at: :ref:`unitofwork_transaction`. .. versionchanged:: 1.4 The scoping and API methods to work with the :class:`_orm.SessionTransaction` object directly have been simplified. .. seealso:: :ref:`unitofwork_transaction` :meth:`.Session.begin` :meth:`.Session.begin_nested` :meth:`.Session.rollback` :meth:`.Session.commit` :meth:`.Session.in_transaction` :meth:`.Session.in_nested_transaction` :meth:`.Session.get_transaction` :meth:`.Session.get_nested_transaction` NFcztj|||_i|_||_||_|r|j |_t|_ |s|rtjd|j|||j_ |jjj|j|y)NzOCan't start a SAVEPOINT transaction when no existing transaction is in progress autobegin)r_trans_ctx_checkr+ _connections_parentnested_nested_transaction_previous_nested_transactionrD_staterr_take_snapshot _transactiondispatchafter_transaction_create)rXr+parentrrs r,r[zSessionTransaction.__init__ s --g6   070K0KD - &,,-  i0%) ! 66t||TJr.c|jS)ajThe parent :class:`.SessionTransaction` of this :class:`.SessionTransaction`. If this attribute is ``None``, indicates this :class:`.SessionTransaction` is at the top of the stack, and corresponds to a real "COMMIT"/"ROLLBACK" block. If non-``None``, then this is either a "subtransaction" or a "nested" / SAVEPOINT transaction. If the :attr:`.SessionTransaction.nested` attribute is ``True``, then this is a SAVEPOINT, and if ``False``, indicates this a subtransaction. .. versionadded:: 1.0.16 - use ._parent for previous versions )rr]s r,rzSessionTransaction.parent)s ||r.cF|jduxr|jtuSrT)r+rrDr]s r, is_activezSessionTransaction.is_activeCs||4'ADKK6,AAr.c|jturtjd|jtur|stjdy|jt urN|sK|sH|j r$tjd|j zd|stjdyyy|jturtj|y)Nz\This session is in 'committed' state; no further SQL can be emitted within this transaction.z[This session is in 'prepared' state; no further SQL can be emitted within this transaction.zThis Session's transaction has been rolled back due to a previous exception during flush. To begin a new transaction with this Session, first issue Session.rollback(). Original exception was: %s7s2acodezThis session is in 'inactive' state, due to the SQL transaction being rolled back; no further SQL can be emitted within this transaction.) rrFrrrErG_rollback_exceptionPendingRollbackErrorrHResourceClosedError)rX prepared_ok rollback_ok deactive_ok closed_msgs r,_assert_activez!SessionTransaction._assert_activeGs ;;) #,,> [[H $00B [[H ${++ 556 22 3 $% 44F%(3;"[[F ",,Z8 8#r.c8|jxs |j SrT)rrr]s r,_is_transaction_boundaryz+SessionTransaction._is_transaction_boundaryns{{.$,,..r.c |j|jj|fi|}|j||SrT)rr+get_bind_connection_for_bind)rXbindkeyrLr9binds r, connectionzSessionTransaction.connectionrs= $t||$$W77((/@AAr.cR|jt|j||S)Nr)rr"r+)rXrs r,_beginzSessionTransaction._beginws! !$,,VDDr.c|}d}|rJ||fz }|j|ur |S|jtjd|z|j}|rJ|S)NrCz4Transaction %s is not on the active transaction list)rrr)rXuptocurrentrxs r,_iterate_self_and_parentsz,SessionTransaction._iterate_self_and_parents{sr wj F$& (00J "// r.c"|jsm|jj|_|jj|_|jj|_|jj |_y|s0|j js|j jtj|_tj|_tj|_tj|_yrT) rr_new_deleted_dirty _key_switchesr+ _flushingflushweakrefWeakKeyDictionary)rXrs r,rz!SessionTransaction._take_snapshots,, ))DI LL11DM,,--DK!%!;!;D  !7!7 LL   --/ 113 //1 $668r.c|jsJt|jj|jj}|jj |d|j jD]^\}\}}|jjj|||_ ||vs:|jjj|`t|jj|jjD]}|jj|d!|jjrJ|jjjD]Y}|r|js||j vs |j#|j$|jjj&[y)zmRestore the restoration state taken before a transaction began. Corresponds to a rollback. T to_transient)revert_deletionN)rrrrrVr+_expunge_statesritems identity_map safe_discardkeyreplacer _update_impl all_statesmodifiedr_expirerb _modified)rX dirty_only to_expungesoldkeynewkeys r,_restore_snapshotz$SessionTransaction._restore_snapshotsn ,,,,^))$,,*;*;<  $$Zd$C#'#5#5#;#;#= 5 A LL % % 2 21 5AE " ))11!4 5T]]#))$,,*?*?@ ?A LL % %a % > ?<<((((**557 GAqDKK/? !&&$,,";";"E"EF Gr.cl|jsJ|js|jjr|jjj D]<}|j |j|jjj>tjjt|j|j|jjy|jr|jj j#|j |jj$j#|j$|jjj#|j|jj&j#|j&yy)zjRemove the restoration state taken before a transaction began. Corresponds to a commit. N)rrr+expire_on_commitrrrrbrstatelib InstanceState_detach_statesrWrclearrrrcrr)rXrs r,_remove_snapshotz#SessionTransaction._remove_snapshots$ ,,,,{{t||<<\\..99; G !&&$,,";";"E"EF G  " " 1 1T]]#T\\  MM   ! [[ LL   $ $TYY / LL   & &t{{ 3 LL ! ! ( ( 7 LL & & - -d.@.@ A r.cP|j||jvr)|rtjd|j|dSd}d}|jr*|jj ||}|j s]|St|tjr/|}|j|jvr'tjd|j}d} |r|jdi|}|jjr|j|j!}nq|j r|j#}nT|j%r4|j'r|j)}n#|j+}d}n|j-}t|tj}|||| fx|j|<|j|j<|jj.j1|j|||S#|r|j3xYw)NzOConnection is already established for the given bind; execution_options ignoredrFTzMSession already has a Connection associated for the given Connection's EnginerC)rrrwarnrrrrr ConnectionrrconnectrLr+twophasebegin_twophase begin_nestedin_transactionin_nested_transactionget_nested_transactionget_transactionbeginr after_beginclose)rXrrL local_connect should_commitconn transactionbind_is_connections r,rz'SessionTransaction._connection_for_binds  4$$ $  <$$T*1- -  <<<<44T;LMD;; $ 1 12;;$"3"33 444 ||~ $ "  -t--B0AB||$$)="113 "//1 $$&--/"&"="="?K"&"6"6"8K$)M"jjl ",D&2C2C!D && H D  d #d&7&7 &D LL ! ! - -dllD$ GK!  s B8HH%c|j|jjstjd|j y)NzD'twophase' mode not enabled, or not root transaction; can't prepare.)rr+r rr _prepare_implr]s r,preparezSessionTransaction.prepares> << #4<<+@+@,,!  r.c|j|j |jr/|jjj |j|jj }||ur'|j|D]}|j|jjs[tdD]8}|jjrn1|jj:tjd|j_|jjrI t!|j"j%D]}|dj' t.|_yt.|_y#t)j*5|j-dddn #1swYnxYwYt.|_yxYw)NrdzrOver 100 subsequent flushes have occurred within session.commit() - is an after_flush() hook creating new objects?r)rrrr+r before_commitrrcommitrrange _is_cleanrr FlushErrorr rrrvaluesrr safe_reraiserollbackrEr)rXstxsubtransaction _flush_guardts r,rz SessionTransaction._prepare_implsl  << 4;; LL ! ! / / =ll'' d?"%"?"?T"?"J (%%' (||%% %c  <<))+ ""$  nn, << DLL$9$9 $T..5578#AaDLLN#  h  $&&($MMO$$$ s$-;FG F1( G 1F: 6G c:|jd|jtur|j|j |j rt |jjD]\}}}}|s |jt|_|jjj|j|j|j|r(|jr|jjdS|jS)NT)r_to_root)rrrErrrrrrr'r#rFr+r after_commitrr)rXr0rtransr autocloses r,r#zSessionTransaction.commit=s - ;;h &    << 4;;9<!!((*: #5e]I!LLN  # $DK LL ! ! . .t|| <  ! ! #  <<&&&5 5||r.c,|jdd|jj}||ur'|j|D]}|j |}d}|j t tfvr|jD]}|j |jr t|jjD]}|djt|_|jjj!|jt|_|j'|j|}n t|_|j} |sA| j)s1t+j,d|j'|j|j |jr(|r&t#j$d|j_|rt+j0|d|d| jj3| ||r(|jr|jjd S|jS#t#j$}YUxYw#t|_|j'|jwxYw) NT)rrr r)rz\Session's state has been changed on a non-active transaction - this state will be discarded.rwith_tracebackr/)rr+rrrrrDrErrrrrr'r)rGrafter_rollbacksysexc_inforr%rr rraise_after_soft_rollback) rX_capture_exceptionr0r*r+boundary rollback_errrr-sesss r,r)zSessionTransaction.rollbackUs+ $?ll'' d?"%"?"?T"?"J '$$& ' ;;68, ,#==? 2 &&.+2D2D !$[%=%=%D%D%F!G,AaDMMO,.6 * --<r?rr[rrrrrrrrrrrrrrrr#r)rrDrFrIrKrCr.r,r"r"s$L  K<"FBB / %9N//B E$9 G@B,@D@08t!2%%6r.r"ceZdZdZdZej d dYdZdZdZ dZ d Z ejd Z eejd d d dZdZdZdZdZdZej,dZdZej ddZdZdZdZdZdZ d[dZd\dZdej@dddfdZ!dej@dfd Z"dej@dfd!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)d(Z* d]d)Z+d*Z,de-j\dfd+Z/eejd,Z0d-Z1d^d.Z2d/Z3d\d0Z4d1Z5d\d2Z6d3Z7d_d4Z8d5Z9d6Z:d7Z;d`d8Zd;Z?d<Z@ dad=ZA dad>ZBdbd?ZC dcd@ZDdAZEdBZFd_dCZGdDZHdEZIdFZJdGZKdHZLdIZMdJZNd\dKZOdLZPdMZQd\dNZR dddOZS dedPZTdQZUdRZVd`dSZWedTZXdZY edUZZedVZ[edWZ\edXZ]y)fr!zManages persistence operations for ORM-mapped objects. The Session's usage paradigm is described at :doc:`/orm/session`. F)2.0aOThe :paramref:`.Session.autocommit` parameter is deprecated and will be removed in SQLAlchemy version 2.0. The :class:`_orm.Session` now features "autobegin" behavior such that the :meth:`.Session.begin` method may be called if a transaction has not yet been started yet. See the section :ref:`session_explicit_begin` for background.) autocommitNTc Dtj|_i|_i|_||_i|_d|_d|_d|_ d|_ ||_ t|_ ||_||_||_|r|rt#j$dd|_nd|_||_| r| nt*j,|_| r|j0j3| |*|j5D]\} }|j7| ||t8|j<y)a~Construct a new Session. See also the :class:`.sessionmaker` function which is used to generate a :class:`.Session`-producing callable with a given set of arguments. :param autocommit: Defaults to ``False``. When ``True``, the :class:`.Session` does not automatically begin transactions for individual statement executions, will acquire connections from the engine on an as-needed basis, releasing to the connection pool after each statement. Flushes will begin and commit (or possibly rollback) their own transaction if no transaction is present. When using this mode, the :meth:`.Session.begin` method may be used to explicitly start transactions, but the usual "autobegin" behavior is not present. :param autoflush: When ``True``, all query operations will issue a :meth:`~.Session.flush` call to this ``Session`` before proceeding. This is a convenience feature so that :meth:`~.Session.flush` need not be called repeatedly in order for database queries to retrieve results. It's typical that ``autoflush`` is used in conjunction with ``autocommit=False``. In this scenario, explicit calls to :meth:`~.Session.flush` are rarely needed; you usually only need to call :meth:`~.Session.commit` (which flushes) to finalize changes. .. seealso:: :ref:`session_flushing` - additional background on autoflush :param bind: An optional :class:`_engine.Engine` or :class:`_engine.Connection` to which this ``Session`` should be bound. When specified, all SQL operations performed by this session will execute via this connectable. :param binds: A dictionary which may specify any number of :class:`_engine.Engine` or :class:`_engine.Connection` objects as the source of connectivity for SQL operations on a per-entity basis. The keys of the dictionary consist of any series of mapped classes, arbitrary Python classes that are bases for mapped classes, :class:`_schema.Table` objects and :class:`_orm.Mapper` objects. The values of the dictionary are then instances of :class:`_engine.Engine` or less commonly :class:`_engine.Connection` objects. Operations which proceed relative to a particular mapped class will consult this dictionary for the closest matching entity in order to determine which :class:`_engine.Engine` should be used for a particular SQL operation. The complete heuristics for resolution are described at :meth:`.Session.get_bind`. Usage looks like:: Session = sessionmaker(binds={ SomeMappedClass: create_engine('postgresql://engine1'), SomeDeclarativeBase: create_engine('postgresql://engine2'), some_mapper: create_engine('postgresql://engine3'), some_table: create_engine('postgresql://engine4'), }) .. seealso:: :ref:`session_partitioning` :meth:`.Session.bind_mapper` :meth:`.Session.bind_table` :meth:`.Session.get_bind` :param \class_: Specify an alternate class other than ``sqlalchemy.orm.session.Session`` which should be used by the returned class. This is the only argument that is local to the :class:`.sessionmaker` function, and is not sent directly to the constructor for ``Session``. :param enable_baked_queries: defaults to ``True``. A flag consumed by the :mod:`sqlalchemy.ext.baked` extension to determine if "baked queries" should be cached, as is the normal operation of this extension. When set to ``False``, caching as used by this particular extension is disabled. .. versionchanged:: 1.4 The ``sqlalchemy.ext.baked`` extension is legacy and is not used by any of SQLAlchemy's internals. This flag therefore only affects applications that are making explicit use of this extension within their own code. :param expire_on_commit: Defaults to ``True``. When ``True``, all instances will be fully expired after each :meth:`~.commit`, so that all attribute/object access subsequent to a completed transaction will load from the most recent database state. .. seealso:: :ref:`session_committing` :param future: if True, use 2.0 style transactional and engine behavior. Future mode includes the following behaviors: * The :class:`_orm.Session` will not use "bound" metadata in order to locate an :class:`_engine.Engine`; the engine or engines in use must be specified to the constructor of :class:`_orm.Session` or otherwise be configured against the :class:`_orm.sessionmaker` in use * The "subtransactions" feature of :meth:`_orm.Session.begin` is removed in version 2.0 and is disabled when the future flag is set. * The behavior of the :paramref:`_orm.relationship.cascade_backrefs` flag on a :func:`_orm.relationship` will always assume "False" behavior. .. versionadded:: 1.4 .. seealso:: :ref:`migration_20_toplevel` :param info: optional dictionary of arbitrary data to be associated with this :class:`.Session`. Is available via the :attr:`.Session.info` attribute. Note the dictionary is copied at construction time so that modifications to the per- :class:`.Session` dictionary will be local to that :class:`.Session`. :param query_cls: Class which should be used to create new Query objects, as returned by the :meth:`~.Session.query` method. Defaults to :class:`_query.Query`. :param twophase: When ``True``, all transactions will be started as a "two phase" transaction, i.e. using the "two phase" semantics of the database in use along with an XID. During a :meth:`~.commit`, after :meth:`~.flush` has been issued for all attached databases, the :meth:`~.TwoPhaseTransaction.prepare` method on each database's :class:`.TwoPhaseTransaction` will be called. This allows each database to roll back the entire transaction, before each transaction is committed. FNz,Cannot use autocommit mode with future=True.T)rWeakInstanceDictrrrr_Session__bindsr_warn_on_eventsrrfuture_new_sessionidhash_key autoflushrenable_baked_queriesr ArgumentErrorrPr r Query _query_clsinforcr _add_bind _sessions) rXrrXrUrrPr bindsrYr] query_clsrs r,r[zSession.__init__s L%557    $ #'  &( " 0$8! **B#DO#DO  '0)ekk  II  T "  "[[] * TsD) *$( $-- r.c|SrTrCr]s r, __enter__zSession.__enter__s r.c$|jyrT)r)rXtype_value tracebacks r,__exit__zSession.__exit__s  r.c#K|5|j5|ddddddy#1swYxYw#1swYyxYwwrTrr]s r,_maker_context_managerzSession._maker_context_managersE           s(A8,8 A5 8AAz :attr:`_orm.Session.transaction`zFor context manager use, use :meth:`_orm.Session.begin`. To access the current root transaction, use :meth:`_orm.Session.get_transaction`.) alternativewarn_on_attribute_accessc"|jS)a9The current active or inactive :class:`.SessionTransaction`. May be None if no transaction has begun yet. .. versionchanged:: 1.4 the :attr:`.Session.transaction` attribute is now a read-only descriptor that also may return None if no transaction has begun yet. )_legacy_transactionr]s r,rzSession.transactions(''))r.cR|js|j|jSrT)rU _autobeginrr]s r,rozSession._legacy_transactions{{ OO    r.c|jduS)zReturn True if this :class:`_orm.Session` has begun a transaction. .. versionadded:: 1.4 .. seealso:: :attr:`_orm.Session.is_active` N)rr]s r,rzSession.in_transactions  ,,r.c|jduS)zReturn True if this :class:`_orm.Session` has begun a nested transaction, e.g. SAVEPOINT. .. versionadded:: 1.4 Nrr]s r,rzSession.in_nested_transactions''t33r.cp|j}|'|j|j}| |j|S)zaReturn the current root transaction in progress, if any. .. versionadded:: 1.4 )rrrXr2s r,rzSession.get_transactions= !!EMM$=MMEEMM$= r.c|jS)zcReturn the current nested transaction in progress, if any. .. versionadded:: 1.4 rtr]s r,rzSession.get_nested_transactions'''r.ciS)aA user-modifiable dictionary. The initial value of this dictionary can be populated using the ``info`` argument to the :class:`.Session` constructor or :class:`.sessionmaker` constructor or factory methods. The dictionary here is always local to this :class:`.Session` and can be modified independently of all other :class:`.Session` objects. rCr]s r,r]z Session.infos  r.cp|js*|jt|d}|j|usJyy)NTrF)rPrr"rvs r,rqzSession._autobegins:4#4#4#<&ttsubtransactions are not implemented in future Session objects.rz/A transaction is already begun on this Session.) rUNotImplementedErrorrqrrrrrrPr")rXrzr _subtransr2s r,rz Session.begins<` t{{%#  ?? "6)(((    ()v))000?((E111/4D,$   !00E    i GG&t,E$$- --   {{ "?&tF;E$$- --   r.c&|jdS)a"Begin a "nested" transaction on this Session, e.g. SAVEPOINT. The target database(s) and associated drivers must support SQL SAVEPOINT for this method to function correctly. For documentation on SAVEPOINT transactions, please see :ref:`session_begin_nested`. :return: the :class:`.SessionTransaction` object. Note that :class:`.SessionTransaction` acts as a context manager, allowing :meth:`.Session.begin_nested` to be used in a "with" block. See :ref:`session_begin_nested` for a usage example. .. seealso:: :ref:`session_begin_nested` :ref:`pysqlite_serializable` - special workarounds required with the SQLite driver in order for SAVEPOINT to work correctly. Trrjr]s r,rzSession.begin_nestedHs.zzz&&r.cj|jy|jj|jy)aRollback the current transaction in progress. If no transaction is in progress, this method is a pass-through. In :term:`1.x-style` use, this method rolls back the topmost database transaction if no nested transactions are in effect, or to the current nested transaction if one is in effect. When :term:`2.0-style` use is in effect via the :paramref:`_orm.Session.future` flag, the method always rolls back the topmost database transaction, discarding any nested transactions that may be in progress. .. seealso:: :ref:`session_rollback` :ref:`unitofwork_transaction` Nr/)rr)rUr]s r,r)zSession.rollbackas.,    $     & & &     $??$001KLL !!#r.c ~|s|}|jdd}||jdi|}|j|||S)an Return a :class:`_engine.Connection` object corresponding to this :class:`.Session` object's transactional state. If this :class:`.Session` is configured with ``autocommit=False``, either the :class:`_engine.Connection` corresponding to the current transaction is returned, or if no transaction is in progress, a new one is begun and the :class:`_engine.Connection` returned (note that no transactional state is established with the DBAPI until the first SQL statement is emitted). Alternatively, if this :class:`.Session` is configured with ``autocommit=True``, an ad-hoc :class:`_engine.Connection` is returned using :meth:`_engine.Engine.connect` on the underlying :class:`_engine.Engine`. Ambiguity in multi-bind or unbound :class:`.Session` objects can be resolved through any of the optional keyword arguments. This ultimately makes usage of the :meth:`.get_bind` method for resolution. :param bind_arguments: dictionary of bind arguments. May include "mapper", "bind", "clause", other custom arguments that are passed to :meth:`.Session.get_bind`. :param bind: deprecated; use bind_arguments :param mapper: deprecated; use bind_arguments :param clause: deprecated; use bind_arguments :param close_with_result: Passed to :meth:`_engine.Engine.connect`, indicating the :class:`_engine.Connection` should be considered "single use", automatically closing when the first result set is closed. This flag only has an effect if this :class:`.Session` is configured with ``autocommit=True`` and does not already have a transaction in progress. .. deprecated:: 1.4 this parameter is deprecated and will be removed in SQLAlchemy 2.0 :param execution_options: a dictionary of execution options that will be passed to :meth:`_engine.Connection.execution_options`, **when the connection is first procured only**. If the connection is already present within the :class:`.Session`, a warning is emitted and the arguments are ignored. .. seealso:: :ref:`session_transaction_isolation` :param \**kw: deprecated; use bind_arguments rN)close_with_resultrLrC)poprr)rXrNrrLkwrs r,rzSession.connectionsXBN!!&$/ < 4==2>2D(( //)  r.c $tj||j|jr|jj ||S|jJ|j sJ|j di|}|r|jdi|}|S)NrC)rrrrqrrPr rL)rXrrLrrs r,rzSession._connection_for_binds--d3    (DOO,=$$99)   (((v~~## )4))>,=>D r.c tjtj|}|r,t j d|s|}n"|j |n|si}n t|}|jjdddk(rtj|d}nd}t j|}||j||||||du\}}n%|jd||jddi}|r|j!} n'|j"j$} |rt'| |gz} | rQt)||||||| } t+| D]\} } | | _| | } | s| cS| j.}| j0}|j2d i|}|j4r/|j7|d}|jtd }n|j7|}|j9||xsi|} |r|j;|||||| } | S) aMExecute a SQL expression construct. Returns a :class:`_engine.Result` object representing results of the statement execution. E.g.:: from sqlalchemy import select result = session.execute( select(User).where(User.id == 5) ) The API contract of :meth:`_orm.Session.execute` is similar to that of :meth:`_future.Connection.execute`, the :term:`2.0 style` version of :class:`_future.Connection`. .. versionchanged:: 1.4 the :meth:`_orm.Session.execute` method is now the primary point of ORM statement execution when using :term:`2.0 style` ORM usage. :param statement: An executable statement (i.e. an :class:`.Executable` expression such as :func:`_expression.select`). :param params: Optional dictionary, or list of dictionaries, containing bound parameter values. If a single dictionary, single-row execution occurs; if a list of dictionaries, an "executemany" will be invoked. The keys in each dictionary must correspond to parameter names present in the statement. :param execution_options: optional dictionary of execution options, which will be associated with the statement execution. This dictionary can provide a subset of the options that are accepted by :meth:`_engine.Connection.execution_options`, and may also provide additional options understood only in an ORM context. :param bind_arguments: dictionary of additional arguments to determine the bind. May include "mapper", "bind", or other custom arguments. Contents of this dictionary are passed to the :meth:`.Session.get_bind` method. :param mapper: deprecated; use the bind_arguments dictionary :param bind: deprecated; use the bind_arguments dictionary :param \**kw: deprecated; use the bind_arguments dictionary :return: a :class:`_engine.Result` object. zPassing bind arguments to Session.execute() as keyword arguments is deprecated and will be removed SQLAlchemy 2.0. Please use the bind_arguments parameter.compile_state_pluginNormclause future_resultT)rF)rrC)rexpectr StatementRolerwarn_deprecated_20rcrb_propagate_attrsrkr_get_plugin_class_for_plugincoerce_to_immutabledictorm_pre_session_exec setdefaultrVr^rdo_orm_executerWr$ enumeraterPrJrMrrPr _execute_20orm_setup_cursor_result)rXrJrerLrNra _add_eventrrYrZorm_exec_stateidxfnrxrrs r,rdzSession.executesYB$$U%8%8)D  # #;  "!#%%b)N!.1N  & & * *+A4 H !- I I5! !%  889JK  ("66!%T1  !  % %h : 1 7 7 $'!  !/AACK--66K";/:,> ,!!N%[1 "R582N+!M  " '00I . F F t}}.~. ??,,TT,JD 1 7 75)! ,,T2D!!)V\r;LM &>>! F r.c L|j|f|||d|jS)zExecute a statement and return a scalar result. Usage and parameters are the same as that of :meth:`_orm.Session.execute`; the return result is a scalar Python value. rerLrN)rdscalarrXrJrerLrNrs r,rzSession.scalars; t||  /)    &(  r.c L|j|f|||d|jS)aExecute a statement and return the results as scalars. Usage and parameters are the same as that of :meth:`_orm.Session.execute`; the return result is a :class:`_result.ScalarResult` filtering object which will return single elements rather than :class:`_row.Row` objects. :return: a :class:`_result.ScalarResult` object .. versionadded:: 1.4.24 Added :meth:`_orm.Session.scalars` .. versionadded:: 1.4.26 Added :meth:`_orm.scoped_session.scalars` r)rdscalarsrs r,rzSession.scalarss;.t||  /)    ')  r.c(|jdy)aClose out the transactional resources and ORM objects used by this :class:`_orm.Session`. This expunges all ORM objects associated with this :class:`_orm.Session`, ends any transaction in progress and :term:`releases` any :class:`_engine.Connection` objects which this :class:`_orm.Session` itself has checked out from associated :class:`_engine.Engine` objects. The operation then leaves the :class:`_orm.Session` in a state which it may be used again. .. tip:: The :meth:`_orm.Session.close` method **does not prevent the Session from being used again**. The :class:`_orm.Session` itself does not actually have a distinct "closed" state; it merely means the :class:`_orm.Session` will release all database connections and ORM objects. .. versionchanged:: 1.4 The :meth:`.Session.close` method does not immediately create a new :class:`.SessionTransaction` object; instead, the new :class:`.SessionTransaction` is created only if the :class:`.Session` is used again for a database operation. .. seealso:: :ref:`session_closing` - detail on the semantics of :meth:`_orm.Session.close` FrAN _close_implr]s r,rz Session.closes< E*r.c(|jdy)aClose this Session, using connection invalidation. This is a variant of :meth:`.Session.close` that will additionally ensure that the :meth:`_engine.Connection.invalidate` method will be called on each :class:`_engine.Connection` object that is currently in use for a transaction (typically there is only one connection unless the :class:`_orm.Session` is used with multiple engines). This can be called when the database is known to be in a state where the connections are no longer safe to be used. Below illustrates a scenario when using `gevent `_, which can produce ``Timeout`` exceptions that may mean the underlying connection should be discarded:: import gevent try: sess = Session() sess.add(User()) sess.commit() except gevent.Timeout: sess.invalidate() raise except: sess.rollback() raise The method additionally does everything that :meth:`_orm.Session.close` does, including that all ORM objects are expunged. TrNrr]s r,rAzSession.invalidatesD D)r.c|j|j1|jjD]}|j|yyrT) expunge_allrrr)rXrArs r,rzSession._close_impl>sK     (#00JJL . !!*- . )r.c&|jjt|jz}|jj t j |_i|_i|_tjj||y)zRemove all object instances from this ``Session``. This is equivalent to calling ``expunge(obj)`` on all objects in this ``Session``. N) rrrWr_killrrRrrrr)rXrs r,rzSession.expunge_allDsl&&113d499oE  !$557  --j$?r.c t|}|jr||j|<y|jr:||j|j<|j D]}||j|<yt jd|z#t j$r\}t|ts.tjt jd|z|n||j|<Yd}~yYd}~yd}~wwxYw)Nz!Not an acceptable bind target: %sreplace_context) r is_selectablerS is_mapperclass_ _all_tablesrrZNoInspectionAvailablertyperr:)rXrrr| _selectableerrs r,r^zSession._add_bindTs 3#66F!!'!8!8!>$.. A #1>(( A  5  AcllnQ.?@@ As-B=BBc$ tj|}|j||ik(rtjdtjj|}tjt|}t!j"|||j$||| !tj&dt)|zy#tj$r4}t j tj ||Yd}~d}~wwxYw)al Expire and refresh attributes on the given instance. The selected attributes will first be expired as they would when using :meth:`_orm.Session.expire`; then a SELECT statement will be issued to the database to refresh column-oriented attributes with the current value available in the current transaction. :func:`_orm.relationship` oriented attributes will also be immediately loaded if they were already eagerly loaded on the object, using the same eager loading strategy that they were loaded with originally. Unloaded relationship attributes will remain unloaded, as will relationship attributes that were originally lazy loaded. .. versionadded:: 1.4 - the :meth:`_orm.Session.refresh` method can also refresh eagerly loaded attributes. .. tip:: While the :meth:`_orm.Session.refresh` method is capable of refreshing both column and relationship oriented attributes, its primary focus is on refreshing of local column-oriented attributes on a single instance. For more open ended "refresh" functionality, including the ability to refresh the attributes on many objects at once while having explicit control over relationship loader strategies, use the :ref:`populate existing ` feature instead. Note that a highly isolated transaction will return the same values as were previously read in that same transaction, regardless of changes in database state outside of that transaction. Refreshing attributes usually only makes sense at the start of a transaction where database rows have not yet been accessed. :param attribute_names: optional. An iterable collection of string attribute names indicating a subset of attributes to be refreshed. :param with_for_update: optional boolean ``True`` indicating FOR UPDATE should be used, or may be a dictionary containing flags to indicate a more specific set of FOR UPDATE flags for the SELECT; flags should match the parameters of :meth:`_query.Query.with_for_update`. Supersedes the :paramref:`.Session.refresh.lockmode` parameter. .. seealso:: :ref:`session_expire` - introductory material :meth:`.Session.expire` :meth:`.Session.expire_all` :ref:`orm_queryguide_populate_existing` - allows any ORM query to refresh objects as they would be loaded normally. rNzqwith_for_update should be the boolean value True, or a dictionary with options. A blank dictionary is ambiguous.) refresh_statewith_for_updateonly_load_propszCould not refresh instance '%s')rinstance_staterNO_STATErr:UnmappedInstanceError _expire_staterrZr ForUpdateArg_from_argumentrselectrr load_on_identrrr)rXr;attribute_namesrr rstmts r,refreshzSession.refreshst --h7E 5/2 b &&3   ,,;;OLzz-12  ! ! # / /   ,,1L4JJ  '||  KK))(3 #   sCD*D  Dc|jjD]2}|j|j|jj4y)aExpires all persistent instances within this Session. When any attributes on a persistent instance is next accessed, a query will be issued using the :class:`.Session` object's current transactional context in order to load all expired attributes for the given instance. Note that a highly isolated transaction will return the same values as were previously read in that same transaction, regardless of changes in database state outside of that transaction. To expire individual objects and individual attributes on those objects, use :meth:`Session.expire`. The :class:`.Session` object's default behavior is to expire all state whenever the :meth:`Session.rollback` or :meth:`Session.commit` methods are called, so that new state can be loaded for the new transaction. For this reason, calling :meth:`Session.expire_all` should not be needed when autocommit is ``False``, assuming the transaction is isolated. .. seealso:: :ref:`session_expire` - introductory material :meth:`.Session.expire` :meth:`.Session.refresh` :meth:`_orm.Query.populate_existing` N)rrrrbrrXr s r, expire_allzSession.expire_all7 sC@&&113 CE MM%**d&7&7&A&A B Cr.c tj|}|j|y#tj$r4}t j tj ||Yd}~Ud}~wwxYw)aExpire the attributes on an instance. Marks the attributes of an instance as out of date. When an expired attribute is next accessed, a query will be issued to the :class:`.Session` object's current transactional context in order to load all expired attributes for the given instance. Note that a highly isolated transaction will return the same values as were previously read in that same transaction, regardless of changes in database state outside of that transaction. To expire all objects in the :class:`.Session` simultaneously, use :meth:`Session.expire_all`. The :class:`.Session` object's default behavior is to expire all state whenever the :meth:`Session.rollback` or :meth:`Session.commit` methods are called, so that new state can be loaded for the new transaction. For this reason, calling :meth:`Session.expire` only makes sense for the specific case that a non-ORM SQL statement was emitted in the current transaction. :param instance: The instance to be refreshed. :param attribute_names: optional list of string attribute names indicating a subset of attributes to be expired. .. seealso:: :ref:`session_expire` - introductory material :meth:`.Session.expire` :meth:`.Session.refresh` :meth:`_orm.Query.populate_existing` rN)rrrrrr:rr)rXr;rr rs r,expirezSession.expireZ sbJ --h7E 5/2 ||  KK))(3 #   s*A1*A,,A1c|j||r|j|j|yt|jj j d|}|j||D]\}}}}|j|y)Nzrefresh-expire)_validate_persistent_expire_attributesrbrWmanagerrjcascade_iterator_conditional_expire)rXr rcascadedomst_dct_s r,rzSession._expire_state s !!%(   $ $UZZ A $$556FNH  $ $U +#+ .1c4((- .r.c|jr1|j|j|jjy||j vr-|j j ||j|yy)z5Expire a state if persistent, else expunge if pendingN)rrrbrrrr_detach)rXr rXs r,rzSession._conditional_expire sV 99 MM%**d&7&7&A&A B dii  IIMM% MM$  r.c  tj|}j|jur!tjdt|zt|jjjd|}|j!|g|Dcgc] \}}}}| c}}}}zy#tj$r4}t j tj ||Yd}~d}~wwxYwcc}}}}w)zRemove the `instance` from this ``Session``. This will free all internal references to the instance. Cascading will be applied according to the *expunge* cascade rule. rNz*Instance %s is not present in this Sessionexpunge)rrrrrr:r session_idrWrrrrWrrjrr) rXr;r rrrrrrs r,rzSession.expunge s --h7E   4== 0,,z/Session._register_persistent.. s 5UeUZZ 5s)rpending_to_persistentrr_identity_key_from_stater intersectionallow_partial_pks issupersetrr&rrrrrrrrr _orphaned_outside_of_sessionrr_commit_all_states_register_alteredrrrr) rXrrr rjr instance_keyorig_keyolds r,_register_persistentzSession._register_persistent s2!% C C Kt9 ;E"5)F))+C%>>uE **<?;"44 ++LO<..?$E*+  99$ ,EIYY,.%%2259 1 1 ? ??#'#4#4#B#B5#I!#L#(99 $>D%%33E:!-EI ''//6O77< L -II0<> 6;2s9 ;v 11 5f 5t7H7H  v& ,,,TYY7 3%dE2 3[--dii8 !E IIMM%  !r.c|jrI|D]C}||jvrd|jj|<+d|jj|<EyyNT)rrr)rXrr s r,r zSession._register_altered sW    ;DII%48D%%**516:D%%,,U3  ; r.cH|jjxsd}|D]}|jrd|jj|<||j }|j j ||jj|dd|_|{|||yr)rpersistent_to_deletedrrrrrr)rXrrr rs r,_remove_newly_deletedzSession._remove_newly_deleted s $ C C Kt 3E  48!!**51$0iik    * *5 1 MM  eT *!EN%0%dE2! 3r.c$|r|jr|jd tj|}|jy#tj $r4}t jt j||Yd}~Td}~wwxYw)aPlace an object into this :class:`_orm.Session`. Objects that are in the :term:`transient` state when passed to the :meth:`_orm.Session.add` method will move to the :term:`pending` state, until the next flush, at which point they will move to the :term:`persistent` state. Objects that are in the :term:`detached` state when passed to the :meth:`_orm.Session.add` method will move to the :term:`persistent` state directly. If the transaction used by the :class:`_orm.Session` is rolled back, objects which were transient when they were passed to :meth:`_orm.Session.add` will be moved back to the :term:`transient` state, and will no longer be present within this :class:`_orm.Session`. .. seealso:: :meth:`_orm.Session.add_all` :ref:`session_adding` - at :ref:`session_basics` z Session.add()rN) rT_flush_warningrrrrrr:r_save_or_update_state)rXr;_warnr rs r,rtz Session.add4 sz2 T))    0 --h7E ""5) ||  KK))(3 #   sAB*B  Bcr|jr|jd|D]}|j|dy)a2Add the given collection of instances to this :class:`_orm.Session`. See the documentation for :meth:`_orm.Session.add` for a general behavioral description. .. seealso:: :meth:`_orm.Session.add` :ref:`session_adding` - at :ref:`session_basics` zSession.add_all()F)rN)rTrrt)rX instancesr;s r,add_allzSession.add_allZ s;       3 4! ,H HHXUH + ,r.cd|_|j|t|}|jd||jD]\}}}}|j|y)NFz save-update)halt_on)r _save_or_update_implrr_contains_state)rXr rjrrrrs r,rzSession._save_or_update_staten sf-2* !!%(u%%66 5$*>*> 7  +OAq#t  % %c * +r.c&|jr|jd tj|}|j|dy#tj $r4}t jt j||Yd}~Wd}~wwxYw)aVMark an instance as deleted. The object is assumed to be either :term:`persistent` or :term:`detached` when passed; after the method is called, the object will remain in the :term:`persistent` state until the next flush proceeds. During this time, the object will also be a member of the :attr:`_orm.Session.deleted` collection. When the next flush proceeds, the object will move to the :term:`deleted` state, indicating a ``DELETE`` statement was emitted for its row within the current transaction. When the transaction is successfully committed, the deleted object is moved to the :term:`detached` state and is no longer present within this :class:`_orm.Session`. .. seealso:: :ref:`session_deleting` - at :ref:`session_basics` zSession.delete()rNT)head) rTrrrrrrr:r _delete_implrXr;r rs r,deletezSession.deletex s*       2 3 --h7E %5 ||  KK))(3 #   sA B*B  Bc|j$|r!tjdt|zy|j ||}||j vry|j j||r|j|||r/t|jjjd|}||j |<|r D]\}}}} |j||dyy)NInstance '%s' is not persistedr&F)rrrr_before_attachrrrt _after_attachrWrrjrr$) rXr rr# to_attachcascade_statesrrrrs r,r$zSession._delete_impl s 99 004y7GG''s3 DMM !  e$    uc * " $$55hFN # e #1 11c4!!#q%0 1 r.c P|j||tj|||||S)aReturn an instance based on the given primary key identifier, or ``None`` if not found. E.g.:: my_user = session.get(User, 5) some_object = session.get(VersionedFoo, (5, 10)) some_object = session.get( VersionedFoo, {"id": 5, "version_id": 10} ) .. versionadded:: 1.4 Added :meth:`_orm.Session.get`, which is moved from the now deprecated :meth:`_orm.Query.get` method. :meth:`_orm.Session.get` is special in that it provides direct access to the identity map of the :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:`_orm.Session.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. :param entity: a mapped class or :class:`.Mapper` indicating the type of entity to be loaded. :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 = session.get(SomeClass, 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 = session.get(SomeClass, (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 = session.get(SomeClass, {"id": 5, "version_id": 10}) :param options: optional sequence of loader options which will be applied to the query, if one is emitted. :param populate_existing: causes the method to unconditionally emit a SQL query and refresh the object with the newly loaded data, regardless of whether or not the object is already present. :param with_for_update: optional boolean ``True`` indicating FOR UPDATE should be used, or may be a dictionary containing flags to indicate a more specific set of FOR UPDATE flags for the SELECT; flags should match the parameters of :meth:`_query.Query.with_for_update`. Supersedes the :paramref:`.Session.refresh.lockmode` parameter. :param execution_options: optional dictionary of execution options, which will be associated with the query execution if one is emitted. This dictionary can provide a subset of the options that are accepted by :meth:`_engine.Connection.execution_options`, and may also provide additional options understood only in an ORM context. .. versionadded:: 1.4.29 .. seealso:: :ref:`orm_queryguide_execution_options` - ORM-specific execution options :return: The object instance, or ``None``. )populate_existingrrrL) _get_implrload_on_pk_identity)rXrnidentoptionsr.rrrLs r,rkz Session.get s9R~~    ' ' /+)/  r.c 6tdrjt|} | r | jst j d|zt t} | stjdtt| jk7r8t jddjd| jDz| rf| j} | r9t| j!} | rt| D] } | | | < t#fd| j$D|sZ| j*sN|L|j-| | }|#t/|j0| j2sy|S|t4j6uryt8j:j<}|r|d |iz }t?j@| jCtD}|$tFjHjK||_&|r|jN|}|r|jPdi|}||||S#t&$rX}tj(t jd djd | j$Dz| Yd}~Zd}~wwxYw)N__composite_values__z(Expected mapped class or mapper, got: %rrT)defaultzoIncorrect number of values in identifier to formulate primary key for session.get(); primary key columns are %s,c3&K|] }d|z ywz'%s'NrC)rcs r,rz$Session._get_impl..Q s#K1FQJ#Ksc3<K|]}|jywrTr)rproprs r,rz$Session._get_impl..e s",)2,szIncorrect names of values in identifier to formulate primary key for session.get(); primary key attribute names are %s (synonym names are also accepted)c3:K|]}d|jzywr8r;)rr<s r,rz$Session._get_impl..p s!# $#TXX-#srr_populate_existing)rrC))hasattrr4rrrrZrrbrto_listlen primary_keyrr _pk_synonymsrrrrW_identity_key_propsKeyErrorr:always_refreshr issubclass __class__rrPASSIVE_CLASS_MISMATCHrrrrrset_label_styler r rr_for_update_argr2rL)rXrnr db_load_fnr2r.rrrLrjis_dict pk_synonyms correct_keyskrr;rrJs ` r,r/zSession._get_impl0 s ')? @#7#L#L#N V--&&:VC 148#'<<$g$  # $F,>,>(? ?,,88#K8J8J#KKL   --K";/<<(   +/0D+E()413-'N4  '+, & : :,($("))',,,^-H#"("4"4fmmDZ>>> ++@@  13DE ELJJv&66 *   &(-(:(:(I(I)I % ) ))73I 3 33H6GHI   %   k  ..I((#(.(B(B#%(   sH77 JA JJcF|jr|jdi}i}|r|jt||j} d|_|j t j|t j|||||||_S#||_wxYw)a Copy the state of a given instance into a corresponding instance within this :class:`.Session`. :meth:`.Session.merge` examines the primary key attributes of the source instance, and attempts to reconcile it with an instance of the same primary key in the session. If not found locally, it attempts to load the object from the database based on primary key, and if none can be located, creates a new instance. The state of each attribute on the source instance is then copied to the target instance. The resulting target instance is then returned by the method; the original source instance is left unmodified, and un-associated with the :class:`.Session` if not already. This operation cascades to associated instances if the association is mapped with ``cascade="merge"``. See :ref:`unitofwork_merging` for a detailed discussion of merging. .. versionchanged:: 1.1 - :meth:`.Session.merge` will now reconcile pending objects with overlapping primary keys in the same way as persistent. See :ref:`change_3601` for discussion. :param instance: Instance to be merged. :param load: Boolean, when False, :meth:`.merge` switches into a "high performance" mode which causes it to forego emitting history events as well as all database access. This flag is used for cases such as transferring graphs of objects into a :class:`.Session` from a second level cache, or to transfer just-loaded objects into the :class:`.Session` owned by a worker thread or process without re-querying the database. The ``load=False`` use case adds the caveat that the given object has to be in a "clean" state, that is, has no pending changes to be flushed - even if the incoming object is detached from any :class:`.Session`. This is so that when the merge operation populates local attributes and cascades to related objects and collections, the values can be "stamped" onto the target object as is, without generating any history or attribute events, and without the need to reconcile the incoming data with any existing related objects or collections that might not be loaded. The resulting objects from ``load=False`` are always produced as "clean", so it is only appropriate that the given objects should be "clean" as well, else this suggests a mis-use of the method. :param options: optional sequence of loader options which will be applied to the :meth:`_orm.Session.get` method when the merge operation loads the existing version of the object from the database. .. versionadded:: 1.4.24 .. seealso:: :func:`.make_transient_to_detached` - provides for an alternative means of "merging" a single object into the :class:`.Session` zSession.merge()F)loadr2 _recursive_resolve_conflict_map) rTrrrrX_mergerr instance_dict)rXr;rRr2rSrTrXs r,mergez Session.merge sx       1 2 "  OO hNN  '"DN;;))(3((2%&; 'DNYDNs AB B c t|}||vr||Sd}|j} | ||jvr!tjdt |z|st jd|j|} tj| dvxrBtj| d xs'|jxrtj| d } nd} | |jvr |j| } nd} | | r | |vr|| } n|sk|j"rt jd|j$j'} tj(| } | | _|j+| d}n'| r%|j-|j.| d| d|} | X|j$j'} tj(| } tj0| } d}|j3| n*tj(| } tj0| } | ||<| || <|| ur|j4|j7|||j4tj8 }|j7| | |j4tj8 }|tj:ur?|tj:ur-||k7r(t=j>d |d t | d |d |j@| _ |jB| _!| jE||jFD]}|jI|||| | ||||sB| jK| |j| jLjNjQ| d|r&| jLjNjS| d| S#t $rd} YwxYw)NFzrInstance %s is already pending in this Session yet is being merged again; this is probably not what you want to dozmerge() with load=False option does not support objects transient (i.e. unpersisted) objects. flush() all changes on mapped instances before merging with load=False.rTzmerge() with load=False option does not support objects marked as 'dirty'. flush() all changes on mapped instances before merging with load=False.r)rr2rz Version id 'z' on merged state z" does not match existing version 'zT'. Leave the version attribute unset when merging to update the most recent version.)*rrrrr rrrrr NEVER_SETrrr r rrEr class_manager new_instancerrrkrrVrversion_id_col_get_state_attr_by_columnPASSIVE_NO_INITIALIZEPASSIVE_NO_RESULTrStaleDataError load_pathr_copy_callablesiterate_propertiesrW _commit_allrr_sa_event_merge_wo_loadrR)rXr state_dictrRr2rSrTrjr\rkey_is_persistentmerged merged_state merged_dictexisting_versionmerged_versionr<s r,rUzSession._merge su% J e$ $ ii ; ! './ 00" 11%8C * 4 4CF B!**3q622,,9%00Q88 !%  $## # **3/ F > S,A%A.s3>> 44K  --::<)88@ #&  !!,/# "MMF#&q6# " >))668F%44V=N>c||jj|s!tjdt |zy)Nz3Instance '%s' is not persistent within this Session)rrrrrrs r,rzSession._validate_persistent s>  //6,,EE"# 7r.c:|j!tjdt|z|j }|j ||}||j vr)||j |<t|j |_|r|j||yy)NzGObject '%s' already has an identity - it can't be registered as pending) rrrrrr)rrA insert_orderr*)rXr rr+s r, _save_implzSession._save_impl s 99 ,,46?6FG  iik''s3  !"DIIe !$TYYE     uc * r.c8|j!tjdt|z|jr3|r|j sy|`n!tjdt|z|j }|y|j||}|jj|d|r|jj|n|jj||r|j||y|r|jj||yy)Nr(zsInstance '%s' has been deleted. Use the make_transient() function to send this object back to the transient state.)rrrrr _attachedrr)rrrrtr*rdeleted_to_persistent)rXr rrr+s r,rzSession._update_impl s 99 ,,09U3CC  >>N00.1:%0@Aiik ; ''s3  %&     % %e ,    ! !% (    uc *  MM / /e <r.cb|j|j|y|j|yrT)rrqrrs r,r zSession._save_or_update_impl s& 99  OOE "   e $r.c  tj|}|j|}d|_|r|j||yy#tj$r4}t j tj ||Yd}~qd}~wwxYw)a Associate an object with this :class:`.Session` for related object loading. .. warning:: :meth:`.enable_relationship_loading` exists to serve special use cases and is not recommended for general use. Accesses of attributes mapped with :func:`_orm.relationship` will attempt to load a value from the database using this :class:`.Session` as the source of connectivity. The values will be loaded based on foreign key and primary key values present on this object - if not present, then those relationships will be unavailable. The object will be attached to this session, but will **not** participate in any persistence operations; its state for almost all purposes will remain either "transient" or "detached", except for the case of relationship loading. Also note that backrefs will often not work as expected. Altering a relationship-bound attribute on the target object may not fire off a backref event, if the effective value is what was already loaded from a foreign-key-holding value. The :meth:`.Session.enable_relationship_loading` method is similar to the ``load_on_pending`` flag on :func:`_orm.relationship`. Unlike that flag, :meth:`.Session.enable_relationship_loading` allows an object to remain transient while still being able to load related items. To make a transient object associated with a :class:`.Session` via :meth:`.Session.enable_relationship_loading` pending, add it to the :class:`.Session` using :meth:`.Session.add` normally. If the object instead represents an existing identity in the database, it should be merged using :meth:`.Session.merge`. :meth:`.Session.enable_relationship_loading` does not improve behavior when the ORM is used normally - object references should be constructed at the object level, not at the foreign key level, so that they are present in an ordinary way before flush() proceeds. This method is not intended for general use. .. seealso:: :paramref:`_orm.relationship.load_on_pending` - this flag allows per-relationship loading of many-to-ones on items that are pending. :func:`.make_transient_to_detached` - allows for an object to be added to a :class:`.Session` without SQL emitted, which then will unexpire attributes on access. rNT) rrrrrr:rr) _load_pendingr*)rXrr rr+s r,enable_relationship_loadingz#Session.enable_relationship_loading sn --c2E''s3 "    uc * ||  KK))#. #   sAB *BB c D|j|j|jk(ry|jrN|jtvr>e//7 #E  ""4/ 99 MM 0 0u = MM . .tU ;r.c tj|}|jS#tj$r4}t j tj ||Yd}~Sd}~wwxYw)zReturn True if the instance is associated with this session. The instance may be pending or persistent within the Session for a result of True. rN)rrrrrr:rr!r%s r, __contains__zSession.__contains__; sb --h7E ##E** ||  KK))(3 #   s(A/*A**A/ctt|jjt|jjzS)zWIterate over all pending or persistent instances within this Session. )iterrWrr'rr]s r,__iter__zSession.__iter__K s?  !!# $tD,=,=,D,D,F'G G  r.cX||jvxs|jj|SrT)rrrrs r,r!zSession._contains_stateT s' !LT%6%6%E%Ee%LLr.c|jrtjd|jry d|_|j |d|_y#d|_wxYw)aFlush all the object changes to the database. Writes out all pending object creations, deletions and modifications to the database as INSERTs, DELETEs, UPDATEs, etc. Operations are automatically ordered by the Session's unit of work dependency solver. Database operations will be issued in the current transactional context and do not affect the state of the transaction, unless an error occurs, in which case the entire transaction is rolled back. You may flush() as often as you like within a transaction to move changes from Python to the database's transaction buffer. For ``autocommit`` Sessions with no active manual transaction, flush() will create a transaction on the fly that surrounds the entire set of operations into the flush. :param objects: Optional; restricts the flush operation to operate only on elements that are in the given collection. This feature is for an extremely narrow set of use cases where particular objects may need to be operated upon before the full flush() occurs. It is not intended for general use. zSession is already flushingNTF)rrrr%_flush)rXobjectss r,rz Session.flushW sQ6 >>,,-JK K >>   #!DN KK "DNUDNs A Ac4tjd|zy)NzUsage of the '%s' operation is not currently supported within the execution stage of the flush process. Results may not be consistent. Consider using alternative event listeners or connection-level operations instead.)rr )rXmethods r,rzSession._flush_warning} s!  FIO O r.ct|jj xr|j xr |j SrT)rcheck_modifiedrrr]s r,r%zSession._is_clean s9!!002 2 MM! II  r.cb|j}|s=|js1|js%|jjj yt |}|jjr)|jj||||j}t|j}t|j}t|j|}|r9t}|D])} tj|}|j%+nd}t} |r0|j'|j)|j|} n |j'|j|} | D]|}t+|j-|} | xr |j.} | r!| s|j0r|j3|gP|j5|| }|sJd| j%|~|r!|j)|j| } n|j| } | D]}|j5|d}|rJd|j6sy|j9dx|_} d|_ |j?d|_|jjA|||jC|s|jjrtE|jj}tFjHjK|jjDcgc]}||jLfc}|jtjNd|z|jjQ|||jSy#tj$r5} tj tj"|| Yd} ~ d} ~ wwxYw#d|_wxYwcc}w#tjT5|jWd dddYy#1swYYyxYwxYw) Nr)isdeletez*Failed to add object to the flush context!Tr}F)rVzAttribute history events accumulated on %d previously clean instances within inner-flush event handlers have been reset, and will not result in database updates. Consider using set_committed_value() within inner-flush event handlers to avoid this warning.r<), _dirty_statesrrrrrrr before_flushrr differencerrrrrr:rrtrVrr _is_orphan has_identityr rregister_objecthas_workrrrTrd after_flushfinalize_flush_changesrArrr rbr after_flush_postexecr#r(r))rXrdirty flush_contextdeletednewobjsetrr r processedproc is_orphanis_persistent_orphan_regrlen_s r,rzSession._flush s""T]]499    ' ' - - / &t, == % % MM & &t]G D&&Edmm$$))nE %%g. UF "&55a8E 5! "FE  99U#008CCGLD99U#..w7D %E%e,77>I#,#C1C1C ,66$$eW-$44$85IIIt e$! %& ''/::9ED%%i0D FE 000FD EE E4 F%% 26**t*2LL !K+ >#'D  -%%'',$ MM % %dM :  0 0 2t00::4,,667&&99&*%6%6%@%@! +#'"3"3 : H KO O MM . .t] C    s||KK11!4(+n(-$4 >""$ >$$$= > > >sh,N2O.:O BO.%O):AO.O%*OO O&&O..P.P!P.!P+ &P.+P.c d|D}|st|d}d}tj||D]\\}}} |j|| |d||d!y)a]Perform a bulk save of the given list of objects. The bulk save feature allows mapped objects to be used as the source of simple INSERT and UPDATE operations which can be more easily grouped together into higher performing "executemany" operations; the extraction of data from the objects is also performed using a lower-latency process that ignores whether or not attributes have actually been modified in the case of UPDATEs, and also ignores SQL expressions. The objects as given are not added to the session and no additional state is established on them. If the :paramref:`_orm.Session.bulk_save_objects.return_defaults` flag is set, then server-generated primary key values will be assigned to the returned objects, but **not server side defaults**; this is a limitation in the implementation. If stateful objects are desired, please use the standard :meth:`_orm.Session.add_all` approach or as an alternative newer mass-insert features such as :ref:`orm_dml_returning_objects`. .. legacy:: The bulk save feature allows for a lower-latency INSERT/UPDATE of rows at the expense of most other unit-of-work features. Features such as object management, relationship handling, and SQL clause support are silently omitted in favor of raw INSERT/UPDATES of records. In SQLAlchemy 2.0, improved versions of the bulk insert/update methods are introduced, with clearer behavior and documentation, new capabilities, and much better performance. For 1.4 use, **please read the list of caveats at** :ref:`bulk_operations_caveats` **before using this method, and fully test and confirm the functionality of all code developed using these systems.** :param objects: a sequence of mapped object instances. The mapped objects are persisted as is, and are **not** associated with the :class:`.Session` afterwards. For each object, whether the object is sent as an INSERT or an UPDATE is dependent on the same rules used by the :class:`.Session` in traditional operation; if the object has the :attr:`.InstanceState.key` attribute set, then the object is assumed to be "detached" and will result in an UPDATE. Otherwise, an INSERT is used. In the case of an UPDATE, statements are grouped based on which attributes have changed, and are thus to be the subject of each SET clause. If ``update_changed_only`` is False, then all attributes present within each object are applied to the UPDATE statement, which may help in allowing the statements to be grouped together into a larger executemany(), and will also reduce the overhead of checking history on attributes. :param return_defaults: when True, rows that are missing values which generate defaults, namely integer primary key defaults and sequences, will be inserted **one at a time**, so that the primary key value is available. In particular this will allow joined-inheritance and other multi-table mappings to insert correctly without the need to provide primary key values ahead of time; however, :paramref:`.Session.bulk_save_objects.return_defaults` **greatly reduces the performance gains** of the method overall. It is strongly advised to please use the standard :meth:`_orm.Session.add_all` approach. :param update_changed_only: when True, UPDATE statements are rendered based on those attributes in each state that have logged changes. When False, all attributes present are rendered into the SET clause with the exception of primary key attributes. :param preserve_order: when True, the order of inserts and updates matches exactly the order in which the objects are given. When False, common types of objects are grouped into inserts and updates, to allow for more batching opportunities. .. versionadded:: 1.3 .. seealso:: :ref:`bulk_operations` :meth:`.Session.bulk_insert_mappings` :meth:`.Session.bulk_update_mappings` c3FK|]}tj|ywrT)rr)rrs r,rz,Session.bulk_save_objects..gsHj//4Hs!cHt|j|jdufSrT)idrjrr s r,z+Session.bulk_save_objects..ps2ell#3UYYd5J"Kr.r;c6|j|jdufSrT)rjrr s r, grouping_keyz/Session.bulk_save_objects..grouping_keyssLL%))4"78 8r.TFN)sorted itertoolsgroupby_bulk_save_mappings) rXrreturn_defaultsupdate_changed_onlypreserve_order obj_statesrrjisupdaters r,bulk_save_objectszSession.bulk_save_objectssz@IH   KJ  9+4*;*;  +  & VX  $ $#  r.c 2|j||dd|d|y)a"Perform a bulk insert of the given list of mapping dictionaries. The bulk insert feature allows plain Python dictionaries to be used as the source of simple INSERT operations which can be more easily grouped together into higher performing "executemany" operations. Using dictionaries, there is no "history" or session state management features in use, reducing latency when inserting large numbers of simple rows. The values within the dictionaries as given are typically passed without modification into Core :meth:`_expression.Insert` constructs, after organizing the values within them across the tables to which the given mapper is mapped. .. versionadded:: 1.0.0 .. legacy:: The bulk insert feature allows for a lower-latency INSERT of rows at the expense of most other unit-of-work features. Features such as object management, relationship handling, and SQL clause support are silently omitted in favor of raw INSERT of records. In SQLAlchemy 2.0, improved versions of the bulk insert/update methods are introduced, with clearer behavior and documentation, new capabilities, and much better performance. For 1.4 use, **please read the list of caveats at** :ref:`bulk_operations_caveats` **before using this method, and fully test and confirm the functionality of all code developed using these systems.** :param mapper: a mapped class, or the actual :class:`_orm.Mapper` object, representing the single kind of object represented within the mapping list. :param mappings: a sequence of dictionaries, each one containing the state of the mapped row to be inserted, in terms of the attribute names on the mapped class. If the mapping refers to multiple tables, such as a joined-inheritance mapping, each dictionary must contain all keys to be populated into all tables. :param return_defaults: when True, rows that are missing values which generate defaults, namely integer primary key defaults and sequences, will be inserted **one at a time**, so that the primary key value is available. In particular this will allow joined-inheritance and other multi-table mappings to insert correctly without the need to provide primary key values ahead of time; however, :paramref:`.Session.bulk_insert_mappings.return_defaults` **greatly reduces the performance gains** of the method overall. If the rows to be inserted only refer to a single table, then there is no reason this flag should be set as the returned default information is not used. :param render_nulls: When True, a value of ``None`` will result in a NULL value being included in the INSERT statement, rather than the column being omitted from the INSERT. This allows all the rows being INSERTed to have the identical set of columns which allows the full set of rows to be batched to the DBAPI. Normally, each column-set that contains a different combination of NULL values than the previous row must omit a different series of columns from the rendered INSERT statement, which means it must be emitted as a separate statement. By passing this flag, the full set of rows are guaranteed to be batchable into one batch; the cost however is that server-side defaults which are invoked by an omitted column will be skipped, so care must be taken to ensure that these are not necessary. .. warning:: When this flag is set, **server side default SQL values will not be invoked** for those columns that are inserted as NULL; the NULL value will be sent explicitly. Care must be taken to ensure that no server-side default functions need to be invoked for the operation as a whole. .. versionadded:: 1.1 .. seealso:: :ref:`bulk_operations` :meth:`.Session.bulk_save_objects` :meth:`.Session.bulk_update_mappings` FNr)rXrjmappingsr render_nullss r,bulk_insert_mappingszSession.bulk_insert_mappingss(~          r.c 2|j||dddddy)aPerform a bulk update of the given list of mapping dictionaries. The bulk update feature allows plain Python dictionaries to be used as the source of simple UPDATE operations which can be more easily grouped together into higher performing "executemany" operations. Using dictionaries, there is no "history" or session state management features in use, reducing latency when updating large numbers of simple rows. .. versionadded:: 1.0.0 .. legacy:: The bulk update feature allows for a lower-latency UPDATE of rows at the expense of most other unit-of-work features. Features such as object management, relationship handling, and SQL clause support are silently omitted in favor of raw UPDATES of records. In SQLAlchemy 2.0, improved versions of the bulk insert/update methods are introduced, with clearer behavior and documentation, new capabilities, and much better performance. For 1.4 use, **please read the list of caveats at** :ref:`bulk_operations_caveats` **before using this method, and fully test and confirm the functionality of all code developed using these systems.** :param mapper: a mapped class, or the actual :class:`_orm.Mapper` object, representing the single kind of object represented within the mapping list. :param mappings: a sequence of dictionaries, each one containing the state of the mapped row to be updated, in terms of the attribute names on the mapped class. If the mapping refers to multiple tables, such as a joined-inheritance mapping, each dictionary may contain keys corresponding to all tables. All those keys which are present and are not part of the primary key are applied to the SET clause of the UPDATE statement; the primary key values, which are required, are applied to the WHERE clause. .. seealso:: :ref:`bulk_operations` :meth:`.Session.bulk_insert_mappings` :meth:`.Session.bulk_save_objects` TFNr)rXrjrs r,bulk_update_mappingszSession.bulk_update_mappingss"j   HdE5% r.ct|}d|_|jd} |rtj|||||ntj |||||||j d|_y#tj5|jddddn #1swYnxYwYHxYw#d|_wxYw)NTrrF) r rrr _bulk_update _bulk_insertr#rr(r)) rXrjrrisstatesrrrrs r,rzSession._bulk_save_mappings%s"&)jj4j0  #((' ((#     #DN  >""$ >$$$= > > >#DNs0AA44B4 B& B4&B/ +B42B77 CcLt|}|jsy|j}|jjD]g}|st |j dst |j ds2|j j||tj\}}}|s|sgyy)a9 Return ``True`` if the given instance has locally modified attributes. This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current value to its previously committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the :attr:`.Session.dirty` collection; a full test for each attribute's net "dirty" status is performed. E.g.:: return session.is_modified(someobject) A few caveats to this method apply: * Instances present in the :attr:`.Session.dirty` collection may report ``False`` when tested with this method. This is because the object may have received change events via attribute mutation, thus placing it in :attr:`.Session.dirty`, but ultimately the state is the same as that loaded from the database, resulting in no net change here. * Scalar attributes may not have recorded the previously set value when a new value was applied, if the attribute was not loaded, or was expired, at the time the new value was received - in these cases, the attribute is assumed to have a change, even if there is ultimately no net change against its database value. SQLAlchemy in most cases does not need the "old" value when a set event occurs, so it skips the expense of a SQL call if the old value isn't present, based on the assumption that an UPDATE of the scalar value is usually needed, and in those few cases where it isn't, is less expensive on average than issuing a defensive SELECT. The "old" value is fetched unconditionally upon set only if the attribute container has the ``active_history`` flag set to ``True``. This flag is set typically for primary key attributes and scalar object references that are not a simple many-to-one. To set this flag for any arbitrary mapped column, use the ``active_history`` argument with :func:`.column_property`. :param instance: mapped instance to be tested for pending changes. :param include_collections: Indicates if multivalued collections should be included in the operation. Setting this to ``False`` is a way to detect only local-column based properties (i.e. scalar columns or many-to-one foreign keys) that would result in an UPDATE for this instance upon flush. Fget_collection get_historyrYT) rrrbrrr?implr NO_CHANGE) rXr;include_collectionsr dict_attradded unchangedrs r, is_modifiedzSession.is_modifiedMsfX&~~ MM,, D'DII'78TYY 6*.))*?*?uj&:&:+@+ 'UIw r.c|jr&|jduxr|jjS|jduxs|jjS)a4True if this :class:`.Session` not in "partial rollback" state. .. versionchanged:: 1.4 The :class:`_orm.Session` no longer begins a new transaction immediately, so this attribute will be False when the :class:`_orm.Session` is first instantiated. "partial rollback" state typically indicates that the flush process of the :class:`_orm.Session` has failed, and that the :meth:`_orm.Session.rollback` method must be emitted in order to fully roll back the transaction. If this :class:`_orm.Session` is not in a transaction at all, the :class:`_orm.Session` will autobegin when it is first used, so in this case :attr:`_orm.Session.is_active` will return True. Otherwise, if this :class:`_orm.Session` is within a transaction, and that transaction has not been rolled back internally, the :attr:`_orm.Session.is_active` will also return True. .. seealso:: :ref:`faq_session_rollback` :meth:`_orm.Session.in_transaction` N)rPrrr]s r,rzSession.is_activesS8 ??!!-M$2C2C2M2M $$,K0A0A0K0K Kr.c6|jjS)zThe set of all persistent states considered dirty. This method returns all states that were modified including those that were possibly deleted. )rrr]s r,rzSession._dirty_statess  ..00r.ctj|jDcgc] }||jvr|j "c}Scc}w)aZThe set of all persistent instances considered dirty. E.g.:: some_mapped_object in session.dirty Instances are considered dirty when they were modified but not deleted. Note that this 'dirty' calculation is 'optimistic'; most attribute-setting or collection modification operations will mark an instance as 'dirty' and place it in this set, even if there is no net change to the attribute's value. At flush time, the value of each attribute is compared to its previously saved value, and if there's no net change, no SQL operation will occur (this is a more expensive operation so it's only done at flush time). To check if an instance has actionable net changes to its attributes, use the :meth:`.Session.is_modified` method. )r IdentitySetrrrrs r,rz Session.dirtysL0"//  -     s%A cntjt|jj S)zDThe set of all instances marked as 'deleted' within this ``Session``)rrrWrr'r]s r,rzSession.deleteds'T]]%9%9%; <==r.cntjt|jj S)zAThe set of all instances marked as 'new' within this ``Session``.)rrrWrr'r]s r,rz Session.news'TYY%5%5%7 899r.) NTFTFFNTNN)FFF)NFNrT)NNNNF)NNrL)T)NFNNN)TN)TNNN)FTTrM)^r<r=r>r? _is_asynciordeprecated_paramsr[_trans_context_managerconnection_callablercrhcontextmanagerrkr deprecated_20rrorrrrmemoized_propertyr]rqrrr)r#rrr EMPTY_DICTrdrrrrArrr^rlrrr r PASSIVE_OFFrrrrrrrrrrrr rrtrrr&r$rkr/rWrUrrqrr rxr)r*rrr!rrr%rrrrrrrrrrrrrCr.r,r!r!sKT  ! }( }(@"  T*0"&  * *! -4 (   T  G! G!R'2=627h$& L \ $//"cP// 6// >+@"*H. @ 2%8$< (- I V9&& 4El ''4A [z!CF,3\ . N0  P!d;3($*L,(+ 6D 1Lr rt lS'r"\| +$=L% B+H" <+  M$#L  y>|  zzEJg R7 r&#PHT L LDL 11  >>> ::r.r!c<eZdZdZdeddddfdZdZdZdZd Z y) r#a A configurable :class:`.Session` factory. The :class:`.sessionmaker` factory generates new :class:`.Session` objects when called, creating them given the configurational arguments established here. e.g.:: from sqlalchemy import create_engine from sqlalchemy.orm import sessionmaker # an Engine, which the Session will use for connection # resources engine = create_engine('postgresql://scott:tiger@localhost/') Session = sessionmaker(engine) with Session() as session: session.add(some_object) session.add(some_other_object) session.commit() Context manager use is optional; otherwise, the returned :class:`_orm.Session` object may be closed explicitly via the :meth:`_orm.Session.close` method. Using a ``try:/finally:`` block is optional, however will ensure that the close takes place even if there are database errors:: session = Session() try: session.add(some_object) session.add(some_other_object) session.commit() finally: session.close() :class:`.sessionmaker` acts as a factory for :class:`_orm.Session` objects in the same way as an :class:`_engine.Engine` acts as a factory for :class:`_engine.Connection` objects. In this way it also includes a :meth:`_orm.sessionmaker.begin` method, that provides a context manager which both begins and commits a transaction, as well as closes out the :class:`_orm.Session` when complete, rolling back the transaction if any errors occur:: Session = sessionmaker(engine) with Session.begin() as session: session.add(some_object) session.add(some_other_object) # commits transaction, closes session .. versionadded:: 1.4 When calling upon :class:`_orm.sessionmaker` to construct a :class:`_orm.Session`, keyword arguments may also be passed to the method; these arguments will override that of the globally configured parameters. Below we use a :class:`_orm.sessionmaker` bound to a certain :class:`_engine.Engine` to produce a :class:`_orm.Session` that is instead bound to a specific :class:`_engine.Connection` procured from that engine:: Session = sessionmaker(engine) # bind an individual session to a connection with engine.connect() as connection: with Session(bind=connection) as session: # work with session The class also includes a method :meth:`_orm.sessionmaker.configure`, which can be used to specify additional keyword arguments to the factory, which will take effect for subsequent :class:`.Session` objects generated. This is usually used to associate one or more :class:`_engine.Engine` objects with an existing :class:`.sessionmaker` factory before it is first used:: # application starts, sessionmaker does not have # an engine bound yet Session = sessionmaker() # ... later, when an engine URL is read from a configuration # file or other events allow the engine to be created engine = create_engine('sqlite:///foo.db') Session.configure(bind=engine) sess = Session() # work with session .. seealso:: :ref:`session_getting` - introductory text on creating sessions using :class:`.sessionmaker`. NTFc ||d<||d<||d<||d<|||d<||_t|j|fi|_y)aJConstruct a new :class:`.sessionmaker`. All arguments here except for ``class_`` correspond to arguments accepted by :class:`.Session` directly. See the :meth:`.Session.__init__` docstring for more details on parameters. :param bind: a :class:`_engine.Engine` or other :class:`.Connectable` with which newly created :class:`.Session` objects will be associated. :param class\_: class to use in order to create new :class:`.Session` objects. Defaults to :class:`.Session`. :param autoflush: The autoflush setting to use with newly created :class:`.Session` objects. :param autocommit: The autocommit setting to use with newly created :class:`.Session` objects. :param expire_on_commit=True: the :paramref:`_orm.Session.expire_on_commit` setting to use with newly created :class:`.Session` objects. :param info: optional dictionary of information that will be available via :attr:`.Session.info`. Note this dictionary is *updated*, not replaced, when the ``info`` parameter is specified to the specific :class:`.Session` construction operation. :param \**kw: all other keyword arguments are passed to the constructor of newly created :class:`.Session` objects. rrXrPrNr])rrr<r)rXrrrXrPrr]rs r,r[zsessionmaker.__init__^sZL6 #;%<!1   BvJ6??VIr: r.c0|}|jS)amProduce a context manager that both provides a new :class:`_orm.Session` as well as a transaction that commits. e.g.:: Session = sessionmaker(some_engine) with Session.begin() as session: session.add(some_object) # commits transaction, closes session .. versionadded:: 1.4 )rk)rXr+s r,rzsessionmaker.begins&&--//r.c |jjD]J\}}|dk(r.d|vr*|j}|j|d||d<9|j ||L|j di|S)aeProduce a new :class:`.Session` object using the configuration established in this :class:`.sessionmaker`. In Python, the ``__call__`` method is invoked on an object when it is "called" in the same way as a function:: Session = sessionmaker() session = Session() # invokes sessionmaker.__call__() r]rC)rrcopyrcrr)rXlocal_kwrPvrzs r,__call__zsessionmaker.__call__s{GGMMO *DAqF{v1FFH&)*#$ ##Aq)  *t{{&X&&r.c :|jj|y)z(Re)configure the arguments for this sessionmaker. e.g.:: Session = sessionmaker() Session.configure(bind=create_engine('sqlite://')) N)rrc)rXnew_kws r, configurezsessionmaker.configures vr.c |jjd|jjddjd|jj DdS)Nz(class_=rc30K|]\}}|d|yw)=NrC)rrPrs r,rz(sessionmaker.__repr__..sC41aA&Cs))rHr<rrrrr]s r,__repr__zsessionmaker.__repr__sB NN # # KK IIC477==?C C  r.) r<r=r>r?r!r[rrrrrCr.r,r#r#s7\@ /;b0,'(  r.r#cVtjD]}|jy)aOClose all sessions in memory. This function consults a global registry of all :class:`.Session` objects and calls :meth:`.Session.close` on them, which resets them to a clean state. This function is not for general use but may be useful for test suites within the teardown scheme. .. versionadded:: 1.3 N)r_r'r)r?s r,r%r%s%  " r.ctj|}t|}|r|j|g|jj |j r|`|jr|`|jr|`yy)aMAlter the state of the given instance so that it is :term:`transient`. .. note:: :func:`.make_transient` is a special-case function for advanced use cases only. The given mapped instance is assumed to be in the :term:`persistent` or :term:`detached` state. The function will remove its association with any :class:`.Session` as well as its :attr:`.InstanceState.identity`. The effect is that the object will behave as though it were newly constructed, except retaining any attribute / collection values that were loaded at the time of the call. The :attr:`.InstanceState.deleted` flag is also reset if this object had been deleted as a result of using :meth:`.Session.delete`. .. warning:: :func:`.make_transient` does **not** "unexpire" or otherwise eagerly load ORM-mapped attributes that are not currently loaded at the time the function is called. This includes attributes which: * were expired via :meth:`.Session.expire` * were expired as the natural effect of committing a session transaction, e.g. :meth:`.Session.commit` * are normally :term:`lazy loaded` but are not currently loaded * are "deferred" via :ref:`deferred` and are not yet loaded * were not present in the query which loaded this object, such as that which is common in joined table inheritance and other scenarios. After :func:`.make_transient` is called, unloaded attributes such as those above will normally resolve to the value ``None`` when accessed, or an empty collection for a collection-oriented attribute. As the object is transient and un-associated with any database identity, it will no longer retrieve these values. .. seealso:: :func:`.make_transient_to_detached` N) rrr-rexpired_attributesr callablesrr)r;r rs r,r&r&sq\  % %h /EuA 5'" ""$  O yy I ~~ Nr.cftj|}|js |jrt j d|j j||_|jr|`|j|j|j|j|jy)aMake the given transient instance :term:`detached`. .. note:: :func:`.make_transient_to_detached` is a special-case function for advanced use cases only. All attribute history on the given instance will be reset as though the instance were freshly loaded from a query. Missing attributes will be marked as expired. The primary key attributes of the object, which are required, will be made into the "key" of the instance. The object can then be added to a session, or merged possibly with the load=False flag, at which point it will look as if it were loaded that way, without emitting SQL. This is a special use case function that differs from a normal call to :meth:`.Session.merge` in that a given persistent state can be manufactured without any SQL calls. .. seealso:: :func:`.make_transient` :meth:`.Session.enable_relationship_loading` zGiven object must be transientN) rrrrrrrjrrrerbrunloaded_expirable)r;r s r,r'r's:  % %h /E 599(()IJJ 55ersa8 "&. #;  (G ' ' ) !(6!(H X  4;;z " DKK $ 4;;z " X p d((p f P6-P6fG1:"G1:TbJ 'J Z$=@$CN%&r.