U
|
¸ý°dcì ã @ s U d Z ddlmZ ddlZddlmZ ddlZddlZddlZddlm Z ddlm
|
Z
|
ddlm Z ddlm Z dd lm Z dd
|
lmZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlZddl m Z ddl m Z ddl m Z ddl m Z dd l m!Z! dd l m"Z" dd l m#Z# dd l m$Z$ dd l m%Z& dd!l'm(Z( dd"l'm)Z) dd#l'm*Z* dd$l'm+Z+ dd%l'm,Z, dd&l-m.Z. dd'l-m/Z/ dd(l-m0Z0 dd)l-m1Z1 dd*l-m2Z2 dd+l-m3Z3 dd,l-m4Z4 dd-l-m5Z5 dd.l-m6Z6 dd/l m7Z7 dd0l m8Z8 dd1l"m9Z9 dd2l$m:Z: dd3l%m;Z; dd4l<m=Z= dd5l<m>Z> dd6l<m?Z? dd7l@mAZA d8d9l mBZB d8d l m!ZC d8d:l mDZD d8d;l mEZE d8d<lBmFZF d8d=lBmGZG d8d>lHmIZI d8d?lJmKZK d8d@lJmLZL d8dAlMmNZN d8dBlMmOZO d8dClDmPZP d8dDlDmQZQ d8dElDmRZR d8dFlDmSZS d8dGlDmTZT d8dHlDmUZU d8dIlVmWZW d8dJlXmYZY d8dKlZm[Z[ d8dLlZm\Z\ d8dMlEm]Z] d8dNl^m_Z_ d8dOl^m`Z` ejrvddPl'maZa ddQl'mbZb ddRl'mcZc ddSl'mdZd ddTlemfZf ddUlemgZg ddVlhmiZi ddWljmkZk ddXl$mlZl d8dYlBmmZm d8dZlBmnZn d8d[lBmoZo d8d\lpmqZq d8d]lpmrZr d8d^lsmtZt d8d_lsmuZu d8d`lsmvZv d8dalwmxZx d8dblJmyZy d8dclzm{Z{ d8ddlzm|Z| d8delzm}Z} d8dflzm~Z~ d8dglzmZ d8dhlzmZ d8dilzmZ d8djlzmZ d8dklzmZ d8dllzmZ d8dmlzm
Z d8dnlVmZ d8dolVmZ d8dplmZ d8dqlmZ d8drlZmZ d8dslZmZ edte duZdvdwdxdydzd{d|d}gZe ¡ Zd~ed< ee&_ee ee df f Ze ee f Zeee( df Zeee ddef Zed Ze_d
ZG dd de`ZdddddZG dd dZG dd de>Zee\Z Z¡Z¢Z£Z¤G ddy dyeEj¥Z¦G dd deZ§G ddw dwe=eIZ¨G ddv dveeLZ©eddvduZªG ddx dxee eª Z«ddddzZ¬ddddd{Zddddd|Z®ddddd}Z¯eE °¡ Z±dS ) z1Provides the Session class and related utilities.é )Ú annotationsN)ÚEnum)ÚAny)ÚCallable)Úcast)ÚDict)ÚGeneric)ÚIterable)ÚIterator)ÚList)ÚNoReturn)ÚOptional)Úoverload)ÚSequence)ÚSet)ÚTuple)ÚType)Ú TYPE_CHECKING)ÚTypeVar)ÚUnioné )Ú
|
attributes)Úbulk_persistence)Úcontext)Údescriptor_props)Úexc)Úidentity)Úloading)Úquery©Ústate)Ú_O)Úinsp_is_mapper)Úis_composite_class)Ú is_orm_option©Úis_user_defined_option)Ú_class_to_mapper)Ú _none_set)Ú _state_mapper)Ú instance_str)ÚLoaderCallableStatus)Ú object_mapper)Ú object_state)Ú PassiveFlag)Ú state_str)Ú FromStatement)ÚORMCompileState)Ú IdentityMap)ÚQuery)Ú InstanceState)Ú _StateChange)Ú_StateChangeState)Ú_StateChangeStates)ÚUOWTransactioné )Úengine)Úsql)Úutil)Ú
|
Connection)ÚEngine)ÚTransactionalContext)Ú
|
dispatcher)Ú EventTarget)Úinspect)Ú Inspectable)Ú coercions)Údml)Úroles)ÚSelect)Ú TableClause)Úvisitors)Ú CompileState)ÚTable)Ú ForUpdateArg)Ú LABEL_STYLE_TABLENAME_PLUS_COL)Ú IdentitySet)ÚLiteral)ÚProtocol)Ú _EntityType)Ú_IdentityKeyType)Ú _InstanceDict)ÚOrmExecuteOptionsParameter)Ú ORMOption)ÚUserDefinedOption)ÚMapper)Ú PathRegistry)ÚRowReturningQuery)ÚResult)ÚRow)Ú
|
RowMapping)Ú Transaction)ÚTwoPhaseTransaction)Ú_CoreAnyExecuteParams)Ú_CoreSingleExecuteParams)Ú_ExecuteOptions)Ú ScalarResult)Ú_InstanceLevelDispatch)Ú_ColumnsClauseArgument)Ú _InfoType)Ú_T0)Ú_T1)Ú_T2)Ú_T3)Ú_T4)Ú_T5)Ú_T6)Ú_T7)Ú_TypedColumnClauseArgument)Ú
|
Executable)ÚExecutableOption)Ú ClauseElement)ÚTypedColumnsClauseRole)ÚForUpdateParameter)ÚTypedReturnsRowsÚ_T)ÚboundÚSessionÚSessionTransactionÚ sessionmakerÚORMExecuteStateÚclose_all_sessionsÚmake_transientÚmake_transient_to_detachedÚobject_sessionz)weakref.WeakValueDictionary[int, Session]Ú _sessions.ú
|
Mapper[_O]ú Mapper[Any]rH )r> r= )Úconditional_savepointÚ rollback_onlyÚ control_fullyÚcreate_savepointc @ s& e Zd ZdZd
|
ddddddd ZdS ) Ú_ConnectionCallableProtoa× a callable that returns a :class:`.Connection` given an instance.
|
|
This callable, when present on a :class:`.Session`, is called only from the
|
ORM's persistence mechanism (i.e. the unit of work flush process) to allow
|
for connection-per-instance schemes (i.e. horizontal sharding) to be used
|
as persistence time.
|
|
This callable is not present on a plain :class:`.Session`, however
|
is established when using the horizontal sharding extension.
|
|
NúOptional[Mapper[Any]]zOptional[object]r r= )ÚmapperÚinstanceÚkwÚreturnc K s d S ©N© )Úselfr r r r r úMd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\sqlalchemy/orm/session.pyÚ__call__¶ s z!_ConnectionCallableProto.__call__)NN)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r r r r r r © s ýr úInstanceState[Any]úOptional[Session]©r r c C s | j S )z[Given an :class:`.InstanceState`, return the :class:`.Session`
|
associated, if any.
|
©Úsessionr r r r Ú_state_session¿ s r c @ st e Zd ZdZee dd¡ddddZee d¡dd d d d
|
d d d dd ddddZ edddddZ
|
d S )Ú_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`.ÚNone©r c C s
|
t dS )z Close *all* sessions in memory.N)r{ )Úclsr r r Ú close_allÉ s
|
z _SessionClassMethods.close_allzsqlalchemy.orm.utilN©r ÚrowÚidentity_tokenzOptional[Type[Any]]úUnion[Any, Tuple[Any, ...]]ú Optional[Any]z%Optional[Union[Row[Any], RowMapping]]z_IdentityKeyType[Any])Úclass_Úidentr r¡ r¢ r c C s t jjj|||||dS )zZReturn an identity key.
|
|
This is an alias of :func:`.util.identity_key`.
|
|
r )r< Z preloadedZorm_utilÚ identity_key)r r¥ r¦ r r¡ r¢ r r r r§ Õ s ûz!_SessionClassMethods.identity_keyÚobjectr ©r r c C s t |S )zxReturn the :class:`.Session` to which an object belongs.
|
|
This is an alias of :func:`.object_session`.
|
|
)r~ )r r r r r r~ í s z#_SessionClassMethods.object_session)NN) r r r r Ú classmethodr< Ú
|
deprecatedr Zpreload_moduler§ r~ r r r r r Æ s$ þ ýù r c @ s e Zd ZdZdZdZdZdZdS )ÚSessionTransactionStater r9 é é é N)r r r ÚACTIVEÚPREPAREDÚ COMMITTEDÚDEACTIVEÚCLOSEDr r r r r¬ ø s
|
r¬ c @ sö e Zd ZU dZdZded< ded< ded< d ed
|
< d ed < d ed < ded< ded< ded< ded< dddd d dddddZdddd ZdXd dd d d!d"d#d$Ze d%dd&d'Z
|
e d(dd)d*Z e d+dd,d-Z e d+dd.d/Z e d+dd0d1Ze d+dd2d3Ze d+dd4d5Ze d+dd6d7Ze d+dd8d9Zd:d;d<d=d>Zd?dd@dAZe dBddCdDZe dEddFdGZe d+ddHdIZe d+ddJdKZe dLddMdNZe dOddPdQZe dRddSdTZe dUddVdWZ d S )Yrz a8 Represents 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Ú
|
parametersÚexecution_optionsÚlocal_execution_optionsÚbind_argumentsr¢ Ú_compile_state_clsÚ_starting_event_idxÚ _events_todoÚ_update_execution_optionsrw r ro rµ ú Optional[_CoreAnyExecuteParams]r¶ ra r· r¸ Ú_BindArgumentsr¹ z Optional[Type[ORMCompileState]]rº Úintr» z List[Any]r¼ úOptional[_ExecuteOptions]r½ z%List[_InstanceLevelDispatch[Session]])r rµ r¶ r· r¹ Úcompile_state_clsÚ events_todoc C s@ || _ || _|| _|| _|j |¡| _|| _|| _t || _
|
dS )zhConstruct a new :class:`_orm.ORMExecuteState`.
|
|
this object is constructed internally.
|
|
N) r rµ r¶ r¸ Ú_execution_optionsÚunionr· r¹ rº Úlistr¼ )r r rµ r¶ r· r¹ r rà r r r Ú__init__Z s ÿzORMExecuteState.__init__r c C s | j | jd d
S )Nr )r¼ r» ©r r r r Ú_remaining_eventst s z!ORMExecuteState._remaining_eventsNzOptional[Executable]z$Optional[OrmExecuteOptionsParameter]úOptional[_BindArguments]ú Result[Any])rµ Úparamsr· r¹ r c C s |dkr| j }t| j}|r&| |¡ d|d< |rÔ| jr²g }td| j}t |td|¡D ]T\}} |dksr| dkrt
|
dt | dt | d¡t|}| | ¡ | |¡ qZqÚttd| j}| td|¡ n| j}| j }
|
|rî|
|
|¡}
|
| jj|||
|
|| d 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 or list of parameters
|
which will be merged into the existing
|
:attr:`.ORMExecuteState.parameters` of this :class:`.ORMExecuteState`.
|
|
.. versionchanged:: 2.0 a list of parameter dictionaries is accepted
|
for executemany executions.
|
|
: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`.
|
|
|
NTÚ_sa_skip_eventszList[Dict[str, Any]]zgCan't apply executemany parameters to statement; number of parameter sets passed to Session.execute() (zW) does not match number of parameter sets given to ORMExecuteState.invoke_statement() (ú)zDict[str, Any])r· r¹ Ú_parent_execute_state)rµ Údictr¹ ÚupdateÚis_executemanyr r¶ Ú itertoolsÚ zip_longestÚsa_excÚInvalidRequestErrorÚlenÚappendr¸ rÅ r Ú_execute_internal) r rµ rÌ r· r¹ Z_bind_argumentsÚ_paramsZexec_many_parametersZ_existing_paramsZ _new_paramsrÄ r r r Úinvoke_statementw sJ 9
|
|
ÿþ ÿ
|
|
ûz ORMExecuteState.invoke_statementr c C s | j dd¡S )aÓ Return 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`
|
|
|
r N)r¹ ÚgetrÈ r r r Ú bind_mapperá s zORMExecuteState.bind_mapperzSequence[Mapper[Any]]c C s | j s
|
g S t| jttfrzg }t }| jjD ]H}|d }|r,t|dd}|r,|jr,|j|kr,| |j¡ |
|
|j¡ q,|S | jj r| j r| j gS g S dS )a Return 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)ZraiseerrN) Úis_orm_statementÚ
|
isinstancerµ rG r0 ÚsetZcolumn_descriptionsrB r ÚaddrØ Úis_dmlrÝ )r ÚresultÚseenÚdÚentÚinspr r r Ú all_mappersý s zORMExecuteState.all_mappersÚboolc C s
|
| j dk S )a return True if the operation is an ORM statement.
|
|
This indicates that the select(), insert(), 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)rº rÈ r r r rß " s z ORMExecuteState.is_orm_statementc C s t | jtS )zreturn True if the parameters are a multi-element list of
|
dictionaries with more than one dictionary.
|
|
.. versionadded:: 2.0
|
|
)rà r¶ rÆ rÈ r r r rÒ / s z ORMExecuteState.is_executemanyc C s | j jS )z*return True if this is a SELECT operation.)rµ Ú is_selectrÈ r r r rë 9 s zORMExecuteState.is_selectc C s | j jo| j jS )z+return True if this is an INSERT operation.)rµ rã Ú is_insertrÈ r r r rì > s zORMExecuteState.is_insertc C s | j jo| j jS )z+return True if this is an UPDATE operation.)rµ rã Ú is_updaterÈ r r r rí C s zORMExecuteState.is_updatec C s | j jo| j jS )z*return True if this is a DELETE operation.)rµ rã Ú is_deleterÈ r r r rî H s zORMExecuteState.is_deletec C s t | jtjtjfS r )rà rµ rE ZUpdateZDeleterÈ r r r Ú_is_crudM s zORMExecuteState._is_crudr r )Úoptsr c K s | j |¡| _ dS )z3Update the local execution options with new values.N)r¸ rÅ ©r rð r r r Úupdate_execution_optionsQ s z(ORMExecuteState.update_execution_optionszwOptional[Union[context.ORMCompileState.default_compile_options, Type[context.ORMCompileState.default_compile_options]]]c C sP | j s
|
d S z | jj}W n tk
|
r, Y d S X |d k rH| tjj¡rH|S d S d S r )rë rµ Z_compile_optionsÚAttributeErrorrà r r1 Zdefault_compile_optionsrñ r r r Ú_orm_compile_optionsU s ÿz$ORMExecuteState._orm_compile_optionsú Optional[InstanceState[Any]]c C s | j jS )aÿ An :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_optionsZ_lazy_loaded_fromrÈ r r r Úlazy_loaded_fromk s z ORMExecuteState.lazy_loaded_fromzOptional[PathRegistry]c C s | ¡ }|dk r|jS dS dS )zÐReturn 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ô Z _current_pathrñ r r r Úloader_strategy_pathz s z$ORMExecuteState.loader_strategy_pathc C s | ¡ }|dk o|jS )aq Return 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ô Z_for_refresh_staterñ r r r Úis_column_load s z ORMExecuteState.is_column_loadc C s* | ¡ }|dkrdS | j}|dk o(|j S )az Return 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)rô rø Zis_root)r rð Úpathr r r Úis_relationship_load£ s
|
z$ORMExecuteState.is_relationship_loadzaUnion[context.QueryContext.default_load_options, Type[context.QueryContext.default_load_options]]c C s" | j st d¡| j dtjj¡S )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.Z_sa_orm_load_options)rë rÕ rÖ r· rÜ r Ú QueryContextÚdefault_load_optionsrÈ r r r rö ½ s ÿ ÿz ORMExecuteState.load_optionszUnion[bulk_persistence.BulkUDCompileState.default_update_options, Type[bulk_persistence.BulkUDCompileState.default_update_options]]c C s" | j st d¡| j dtjj¡S )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.Z_sa_orm_update_options)rï rÕ rÖ r· rÜ r ZBulkUDCompileStateZdefault_update_optionsrÈ r r r Úupdate_delete_optionsÏ s
|
ÿþz%ORMExecuteState.update_delete_optionszSequence[ORMOption]c C s dd | j jD S )Nc S s g | ]}t |r|js|qS r )r$ Z_is_compile_state©Ú.0Úoptr r r Ú
|
<listcomp>å s þz<ORMExecuteState._non_compile_orm_options.<locals>.<listcomp>©rµ Z _with_optionsrÈ r r r Ú_non_compile_orm_optionsã s þz(ORMExecuteState._non_compile_orm_optionszSequence[UserDefinedOption]c C s dd | j jD S )zzThe sequence of :class:`.UserDefinedOptions` that have been
|
associated with the statement being invoked.
|
|
c S s g | ]}t |r|qS r r% rÿ r r r r ñ s þz8ORMExecuteState.user_defined_options.<locals>.<listcomp>r rÈ r r r Úuser_defined_optionsë s þz$ORMExecuteState.user_defined_options)NNNN) r r r r Ú __slots__Ú__annotations__rÇ rÉ rÛ ÚpropertyrÝ ré rß rÒ rë rì rí rî rï rò rô r÷ rø rù rû rö rþ r r r r r r rz sn
|
|
ûj$ c @ s e Zd ZdZdZdZdZdZdS )ÚSessionTransactionOriginzáindicates the origin of a :class:`.SessionTransaction`.
|
|
This enumeration is present on the
|
:attr:`.SessionTransaction.origin` attribute of any
|
:class:`.SessionTransaction` object.
|
|
.. versionadded:: 2.0
|
|
r r r9 r N)r r r r Ú AUTOBEGINÚBEGINÚ BEGIN_NESTEDÚSUBTRANSACTIONr r r r r ø s
|
r c @ s\ e Zd ZU dZdZded< ded< ded< d ed
|
< d ed < d ed< d ed< d ed< ded< ded< dZded< dWddd dddZdd d d d d Ze d d!d"d#Z
|
e dd!d$d%Z e dd!d&d'Z e ejfej¡dXd(d)d*d+d,d-d.Ze ejfej¡dYdd d/d0d1ZdZd d2d3d4d5Zd6d!d7d8Zd[dd6d9d:d;Zd6d!d<d=Ze ejfej¡d>d)d+d?d@dAZd6d!dBdCZe ejfej¡d6d!dDdEZ e ejejfej ¡d\dd6dFdGdHZ e ejej ejfej ¡d]ddd6dIdJdKZ e ej!ej ¡d^dd6dLdMdNZ"dd!dOdPZ#dd!dQdRZ$dd!dSdTZ%dd!dUdVZ&dS )_rx a¬ A :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`
|
|
|
NzOptional[BaseException]Ú_rollback_exceptionzKDict[Union[Engine, Connection], Tuple[Connection, Transaction, bool, bool]]Ú _connectionsrw r ú Optional[SessionTransaction]Ú_parentr¬ Ú_statez5weakref.WeakKeyDictionary[InstanceState[Any], object]Ú_newÚ_deletedÚ_dirtyz>weakref.WeakKeyDictionary[InstanceState[Any], Tuple[Any, Any]]Ú _key_switchesr ÚoriginFrê Únested)r r Úparentc C s t |¡ || _i | _|| _|tjk | _}|| _|rN|sDt
|
d¡|j | _ n$|tj krf|d k srtn |d ksrttj| _| ¡ | | j_| jj | j| ¡ d S )NzOCan't start a SAVEPOINT transaction when no existing transaction is in progress)r? Ú_trans_ctx_checkr r r r r r r rÕ rÖ Ú_nested_transactionÚ _previous_nested_transactionr ÚAssertionErrorr¬ r° r Ú_take_snapshotÚ _transactionÚdispatchZafter_transaction_create)r r r r r r r r rÇ ` s&
|
ÿ
|
|
zSessionTransaction.__init__Ústrr6 r )Úoperation_namer r c C sf |t jkr4| jr(tjd| j ddqbt d¡n.|t jkrJt d¡nt d|j ¡ d¡d S )NzÀThis 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: Z7s2a)ÚcodezThis session is in 'inactive' state, due to the SQL transaction being rolled back; no further SQL can be emitted within this transaction.zThis transaction is closedzThis session is in 'z?' state; no further SQL can be emitted within this transaction.)
|
r¬ r³ r rÕ ZPendingRollbackErrorrÖ r´ ZResourceClosedErrorÚnameÚlower)r r" r r r r Ú _raise_for_prerequisite_state
s
|
|
ú ÿ
|
ÿz0SessionTransaction._raise_for_prerequisite_stater c C s | j S )aa The 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"
|
(an internal marker object used by the flush process) 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.
|
|
)r rÈ r r r r s zSessionTransaction.parentc C s | j d k o| jtjkS r )r r r¬ r° rÈ r r r Ú is_active± s
|
|
þz SessionTransaction.is_activec C s | j p | j S r )r r rÈ r r r Ú_is_transaction_boundary¸ s z+SessionTransaction._is_transaction_boundaryr rÁ r r= )Úbindkeyr· Úkwargsr c K s | j j|f|}| ||¡S r )r Úget_bindÚ_connection_for_bind)r r) r· r* Úbindr r r Ú
|
connection¼ s z SessionTransaction.connection©r r c C s t | j|rtjntj| S r )rx r r r r )r r r r r Ú_beginÈ s ÿûzSessionTransaction._beginz Iterable[SessionTransaction])Úuptor c C sJ | }d}|rF||f7 }|j |kr$qFq|j d kr>t d| ¡q|j }q|S )Nr z4Transaction %s is not on the active transaction list)r rÕ rÖ )r r1 Úcurrenträ r r r Ú_iterate_self_and_parentsÔ s
|
|
|
ÿÿz,SessionTransaction._iterate_self_and_parentsr c C s | j s<| j}|d k st|j| _|j| _|j| _|j| _d S | jtj tj
|
fk}|sd| j j sd| j ¡ t ¡ | _t ¡ | _t ¡ | _t ¡ | _d S r )r( r r r r r r r r r r
|
r Ú _flushingÚflushÚweakrefÚWeakKeyDictionary)r r Zis_beginr r r r è s$ þ
|
|
|
|
z!SessionTransaction._take_snapshot)Ú
|
dirty_onlyr c C sä | j s
|
tt| j | jj¡}| jj|dd | j ¡ D ]6\}\}}| jj
|
|¡ ||_ ||kr8| jj |¡ q8t| j | jj ¡D ]}| jj|dd q| jj r¦t| jj ¡ D ],}|rÊ|jsÊ|| jkr²| |j| jj j¡ q²dS )zmRestore the restoration state taken before a transaction began.
|
|
Corresponds to a rollback.
|
|
T©Ú to_transient)Úrevert_deletionN)r( r rá r rÅ r Ú_expunge_statesr ÚitemsÚ identity_mapÚ safe_discardÚkeyÚreplacer Ú _update_implÚ
|
all_statesÚmodifiedr Ú_expirerÐ Ú _modified)r r8 Z
|
to_expungeÚsZoldkeyZnewkeyr r r Ú_restore_snapshotþ s
|
z$SessionTransaction._restore_snapshotc C s´ | j s
|
t| js`| jjr`| jj ¡ D ]}| |j| jjj ¡ q$t
|
j t | j| j¡ | j ¡ nP| jr°| j}|dk sxt|j | j¡ |j | j¡ |j | j¡ |j | j¡ dS )zjRemove the restoration state taken before a transaction began.
|
|
Corresponds to a commit.
|
|
N)r( r r r Úexpire_on_commitr> rC rE rÐ rF Ústatelibr4 Ú_detach_statesrÆ r Úclearr r rÑ r r )r rG r r r r Ú_remove_snapshot s
|
ÿ z#SessionTransaction._remove_snapshotÚ _SessionBind)r- r· r c C s¶ || j kr&|rt d¡ | j | d S d}d}| jrN| j ||¡}| js|S n4t|tjrv|}|j| j krt
|
d¡n | ¡ }d}zÎ|r|j f |}| j jr°| jd kr°| ¡ }n| jrÀ| ¡ }n| ¡ rF| j j}|dkrì| ¡ rèd}nd}|d kr"| ¡ r
|
| ¡ }n| ¡ }|dkrDd}n"|dkr6| ¡ }ndsNt|n| ¡ }W n |rf| ¡ Y nFX t|tj}|||| f | j |< | j |j< | j j | j | |¡ |S d S )
|
NzOConnection is already established for the given bind; execution_options ignoredr FTzMSession already has a Connection associated for the given Connection's Enginer r
r )r r )r r< Úwarnr r, r rà r: r= rÕ rÖ Úconnectr· r ÚtwophaseZbegin_twophaseÚ begin_nestedÚin_transactionÚjoin_transaction_modeÚin_nested_transactionZ _get_required_nested_transactionZ_get_required_transactionr ÚbeginÚcloser Z after_begin) r r- r· Z local_connectÚ should_commitÚconnÚ transactionrT Zbind_is_connectionr r r r, 6 sn
|
ÿ ÿ
|
|
|
|
|
|
|
|
|
üz'SessionTransaction._connection_for_bindc C s( | j d k s| jjs t d¡| ¡ d S )NzD'twophase' mode not enabled, or not root transaction; can't prepare.)r r rQ rÕ rÖ Ú _prepare_implrÈ r r r Úprepare s
|
ÿzSessionTransaction.preparec C s | j d ks| jr | jj | j¡ | jj}|d k s4t|| k rV|j| dD ] }| ¡ qH| jj st
|
dD ] }| j ¡ rx q| j ¡ qft d¡| j d krô| jjrôz*t| j ¡ D ]}td|d ¡ q°W n( t ¡ | ¡ W 5 Q R X Y nX tj| _d S )N©r1 éd zrOver 100 subsequent flushes have occurred within session.commit() - is an after_flush() hook creating new objects?r^ r )r r r r Z before_commitr r r3 Úcommitr4 ÚrangeÚ _is_cleanr5 r Ú
|
FlushErrorrQ rá r Úvaluesr r\ r< Ú safe_reraiseÚrollbackr¬ r± r )r ÚstxÚsubtransactionZ _flush_guardÚtr r r r[ s.
|
|
ÿ
|
z SessionTransaction._prepare_impl)Ú_to_rootr c C sÀ | j tjk r,| tj¡ | ¡ W 5 Q R X | jd ks<| jrt| j ¡ D ]\}}}}|rJ|
|
¡ qJtj | _ | j j | j ¡ | ¡ | tj¡ | ¡ W 5 Q R X |r¼| jr¼| jj
|
dd d S )NT©ri )r r¬ r± Ú _expect_stater[ r r rá r rc r_ r² r r Z after_commitrM r´ rW )r ri rY ÚtransrX Ú autocloser r r r_ ¾ s ÿ
|
|
zSessionTransaction.commit)Ú_capture_exceptionri r c
|
|
C s¬ | j j}|d k st|| k r6|j| dD ] }| ¡ q(| }d }| jtjtjfkrð| ¡ D ]}|j d ksl|j
|
ræzVz<t |j ¡ D ]}|d ¡ q~tj |_| j j | j ¡ W n t ¡ }Y nX W 5 tj |_|j |j
|
d X |} qðqXtj |_qX| j } |s | ¡ s t d¡ |j |j
|
d | tj¡ | ¡ W 5 Q R X | j r\|r\t ¡ d | j _|r~|d r~|d |d ¡| j | | ¡ |r¨| j r¨| j jdd d S )Nr] )r8 r z\Session's state has been changed on a non-active transaction - this state will be discarded.r9 Trj ) r r r r3 rW r r¬ r° r± r r r³ rH rá r rc re r Zafter_rollbackÚsysÚexc_infora r< rO rk r´ r Úwith_tracebackZafter_soft_rollback)
|
r rn ri rf rg ÚboundaryZ rollback_errrZ rh Úsessr r r re Ù sT
|
þ ÿ
|
ÿzSessionTransaction.rollback©Ú
|
invalidater c C s | j r| j| j_| j| j_t| j ¡ D ]J\}}}}|rJ| jd krJ| ¡ |r\|j
|
r\| ¡ |r(| jd kr(| ¡ q(t j | _| j}|j || ¡ d S r )r r r r r r rá r rc ru r' rW r¬ r´ r r Zafter_transaction_end)r ru r. rZ rX rm rs r r r rW s ÿ
|
ÿ
|
|
|
zSessionTransaction.closec C s | j S r r rÈ r r r Ú _get_subjectC s z SessionTransaction._get_subjectc C s | j tjkS r )r r¬ r° rÈ r r r Ú_transaction_is_activeF s z)SessionTransaction._transaction_is_activec C s | j tjkS r )r r¬ r´ rÈ r r r Ú_transaction_is_closedI s z)SessionTransaction._transaction_is_closedc C s | j ttfkS r )r r² r´ rÈ r r r Ú_rollback_can_be_calledL s z*SessionTransaction._rollback_can_be_called)N)N)F)N)F)F)FF)F)'r r r r r r r rÇ r& r r r' r( r5 Zdeclare_statesr¬ r° r7 Ú NO_CHANGEr. r0 r3 r rH rM r, r\ r± r[ r´ r_ r³ re ÚANYrW rv rw rx ry r r r r rx s
|
& ü% ÿ ý ÿ
|
ÿ ÿY ÿ!
|
þýú ÿ? ÿ c @ s
|
e Zd ZU dZdZded< ded< ded< ded < d
|
ed < d ed < ded< ded< ded< ded< ded< ded< ded< ded< ded< ded< d ed < dcd d d d dd d d d dd d! d"dd#dddd$dd%d&d'dd( d)d*Zd Zd+ed,< d Zd-ed.< d/d/d0d1d2Z d3d3d3d4d5d6d7Z
|
e j d/d8d0d9d:Z dd;d<d=Zdd;d>d?Zdd;d@dAZdd;dBdCZejdDd;dEdFZddddGdHdIdJZdeddGdKdLdMZdGd;dNdOZd4d;dPdQZd4d;dRdSZd4d;dTdUZdfdVdWdXdYdZd[Zdgd\dWd3dXd]d^d_Z e dhej d d d d`dadbdcdddVdeded#d3dfdgdhZ e diej d d d d`dadbdidddVdededdjdfdkdhZ djej d d d ddadbdidddVdededd3dfdldhZ e dkej d d d dmdndidddVdededodpdqdrZ e dlej d d d dmdbdidddVdededjdpdsdrZ dmej d d d dmdbdidddVdededjdpdtdrZ e dnej d dudvdcdddVd3dwdxdydzZ!e doej d dudbdcdddVd3d3dxd{dzZ!dpej d dudbdcdddVd3d3dxd|dzZ!e dqej d dudvdidddVd3d}dxd~dZ"e drej d dudbdidddVd3ddxddZ"dsej d dudbdidddVd3ddxddZ"d4d;ddZ#d4d;d
dZ$dd4dddZ%d4d;ddZ&dd\d4dddZ'dd\d4dddZ(dd\d4dddZ)dtd d d ddddd"ddd3ddddZ*e d d¡d¢d£d¤Z+e d¥d¦d§d¨d¤Z+e d©dªd«d¬dd¤Z+e d©dªd®d¯d°d±d¤Z+e d©dªd®d²d³d´dµd¤Z+e d©dªd®d²d¶d·d¸d¹d¤Z+e d©dªd®d²d¶dºd»d¼d½d¤Z+e d©dªd®d²d¶dºd¾d¿dÀdÁd¤Z+e d©dªd®d²d¶dºd¾dÂdÃdÄ dÅd¤Z+e dÆd3dÇdÈdÉd¤Z+dÆd3dÇdÈdÊd¤Z+d e,j-d ej d fdËdÌd3dÍdÎdddVdÏdÐdÑdÒZ.ej/e j dÓd;dÔdÕZ0ej1 2dÖe3j4¡d4d;d×dØZ5dudÙdÚdÛd4dÜdÝdÞZ6d4d;dßdàZ7dvdÙdÚd4dádâdãZ8dädÚd4dådædçZ9dwdädd4dèdédêZ:dÙd4dëdìdíZ;dxdîdd4dïdðdñZ<dòd4dódôdõZ=dîd4dódöd÷Z>dîd4dódødùZ?dydÙdd4dúdûdüZ@dýd4dþdÿd ZAdäd4dddZBdÙd4dëddZCdädÙdd4dddZDd dd d ej d d dd
|
d ddÛdedddVd d ddZEd dd d ej d d dd
|
ddddÛdedddVd d
|
ddZFd d dddd ddddZGd ddd d dd d dd d d!ZHdäd4dd"d#ZIdäd4dd$d%ZJdzdädd4d&d'd(ZKdäd4dd)d*ZLdÙd4d+d,d-ZMdädÙdd.d/d0ZNdädÙd4d.d1d2ZOdÙddëd3d4ZPd5d;d6d7ZQdäddd8d9ZRd{d:d4d;d<d=ZSd3d4d>d?d@ZTdd;dAdBZUd|dCd4d;dDdEZVd}dýdddd4dFdGdHZWd~dIdJddd4dKdLdMZXdIdJd4dNdOdPZYdËdQdddddd4dRdSdTZZddÙdddUdVdWZ[e\dd;dXdYZ]e\dîd;dZd[Z^e\d\d;d]d^Z_e\d\d;d_d`Z`e\d\d;dadbZad S ( rw zManages persistence operations for ORM-mapped objects.
|
|
The Session's usage paradigm is described at :doc:`/orm/session`.
|
|
|
Fzdispatcher[Session]r r2 r> z Dict[InstanceState[Any], Any]r r z#Optional[Union[Engine, Connection]]r- z#Dict[_SessionBindKey, _SessionBind]Ú_Session__bindsrê r4 Ú_warn_on_eventsr r r rÀ Úhash_keyÚ autoflushrI Úenable_baked_queriesrQ ÚJoinTransactionModerT zType[Query[Any]]Ú
|
_query_clsNTr ) r ÚfuturerI Ú autobeginrQ Úbindsr ÚinfoÚ query_clsÚ
|
autocommitrT úOptional[_SessionBind]z Literal[True]z-Optional[Dict[_SessionBindKey, _SessionBind]]úOptional[_InfoType]zOptional[Type[Query[Any]]]zLiteral[False]) r- r r rI r rQ r
r r r r rT c C sö | rt d¡t ¡ | _|s&t d¡i | _i | _|| _i | _d| _ d| _
|
d| _ d| _ t | _|| _|| _|| _|| _| r| tjkrt d| d¡| | _|| _|
|
rª|
|
ntj| _| rÂ| j | ¡ |dk rè| ¡ D ]\} }| | |¡ qÒ| t | j< dS )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 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.
|
|
.. seealso::
|
|
:ref:`session_flushing` - additional background on autoflush
|
|
:param autobegin: Automatically start transactions (i.e. equivalent to
|
invoking :meth:`_orm.Session.begin`) when database access is
|
requested by an operation. Defaults to ``True``. Set to
|
``False`` to prevent a :class:`_orm.Session` from implicitly
|
beginning transactions after construction, as well as after any of
|
the :meth:`_orm.Session.rollback`, :meth:`_orm.Session.commit`,
|
or :meth:`_orm.Session.close` methods are called.
|
|
.. versionadded:: 2.0
|
|
.. seealso::
|
|
:ref:`session_autobegin_disable`
|
|
: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+psycopg2://engine1'),
|
SomeDeclarativeBase: create_engine('postgresql+psycopg2://engine2'),
|
some_mapper: create_engine('postgresql+psycopg2://engine3'),
|
some_table: create_engine('postgresql+psycopg2://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: legacy; defaults to ``True``.
|
A parameter 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: Deprecated; this flag is always True.
|
|
.. 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.
|
|
:param autocommit: the "autocommit" keyword is present for backwards
|
compatibility but must remain at its default value of ``False``.
|
|
:param join_transaction_mode: Describes the transactional behavior to
|
take when a given bind is a :class:`_engine.Connection` that
|
has already begun a transaction outside the scope of this
|
:class:`_orm.Session`; in other words the
|
:meth:`_engine.Connection.in_transaction()` method returns True.
|
|
The following behaviors only take effect when the :class:`_orm.Session`
|
**actually makes use of the connection given**; that is, a method
|
such as :meth:`_orm.Session.execute`, :meth:`_orm.Session.connection`,
|
etc. are actually invoked:
|
|
* ``"conditional_savepoint"`` - this is the default. if the given
|
:class:`_engine.Connection` is begun within a transaction but
|
does not have a SAVEPOINT, then ``"rollback_only"`` is used.
|
If the :class:`_engine.Connection` is additionally within
|
a SAVEPOINT, in other words
|
:meth:`_engine.Connection.in_nested_transaction()` method returns
|
True, then ``"create_savepoint"`` is used.
|
|
``"conditional_savepoint"`` behavior attempts to make use of
|
savepoints in order to keep the state of the existing transaction
|
unchanged, but only if there is already a savepoint in progress;
|
otherwise, it is not assumed that the backend in use has adequate
|
support for SAVEPOINT, as availability of this feature varies.
|
``"conditional_savepoint"`` also seeks to establish approximate
|
backwards compatibility with previous :class:`_orm.Session`
|
behavior, for applications that are not setting a specific mode. It
|
is recommended that one of the explicit settings be used.
|
|
* ``"create_savepoint"`` - the :class:`_orm.Session` will use
|
:meth:`_engine.Connection.begin_nested()` in all cases to create
|
its own transaction. This transaction by its nature rides
|
"on top" of any existing transaction that's opened on the given
|
:class:`_engine.Connection`; if the underlying database and
|
the driver in use has full, non-broken support for SAVEPOINT, the
|
external transaction will remain unaffected throughout the
|
lifespan of the :class:`_orm.Session`.
|
|
The ``"create_savepoint"`` mode is the most useful for integrating
|
a :class:`_orm.Session` into a test suite where an externally
|
initiated transaction should remain unaffected; however, it relies
|
on proper SAVEPOINT support from the underlying driver and
|
database.
|
|
.. tip:: When using SQLite, the SQLite driver included through
|
Python 3.11 does not handle SAVEPOINTs correctly in all cases
|
without workarounds. See the section
|
:ref:`pysqlite_serializable` for details on current workarounds.
|
|
* ``"control_fully"`` - the :class:`_orm.Session` will take
|
control of the given transaction as its own;
|
:meth:`_orm.Session.commit` will call ``.commit()`` on the
|
transaction, :meth:`_orm.Session.rollback` will call
|
``.rollback()`` on the transaction, :meth:`_orm.Session.close` will
|
call ``.rollback`` on the transaction.
|
|
.. tip:: This mode of use is equivalent to how SQLAlchemy 1.4 would
|
handle a :class:`_engine.Connection` given with an existing
|
SAVEPOINT (i.e. :meth:`_engine.Connection.begin_nested`); the
|
:class:`_orm.Session` would take full control of the existing
|
SAVEPOINT.
|
|
* ``"rollback_only"`` - the :class:`_orm.Session` will take control
|
of the given transaction for ``.rollback()`` calls only;
|
``.commit()`` calls will not be propagated to the given
|
transaction. ``.close()`` calls will have no effect on the
|
given transaction.
|
|
.. tip:: This mode of use is equivalent to how SQLAlchemy 1.4 would
|
handle a :class:`_engine.Connection` given with an existing
|
regular database transaction (i.e.
|
:meth:`_engine.Connection.begin`); the :class:`_orm.Session`
|
would propagate :meth:`_orm.Session.rollback` calls to the
|
underlying transaction, but not :meth:`_orm.Session.commit` or
|
:meth:`_orm.Session.close` calls.
|
|
.. versionadded:: 2.0.0rc1
|
|
|
z&autocommit=True is no longer supportedzCThe 'future' parameter passed to Session() may only be set to True.FNz.invalid selection for join_transaction_mode: "ú") rÕ Ú ArgumentErrorr ÚWeakInstanceDictr> r r r- r| r4 r} r r Ú_new_sessionidr~ r r rI r r Ú__args__rT rQ r r3 r r rÑ r= Ú _add_bindr )r r- r r rI r rQ r
r r r r rT r@ r r r rÇ z sR fÿ
|
ÿÿÿþ
|
ÿ zSession.__init__z Optional[TransactionalContext]Ú_trans_context_managerz"Optional[_ConnectionCallableProto]Úconnection_callableÚ_S)r r c C s | S r r rÈ r r r Ú __enter__ s zSession.__enter__r r )Útype_ÚvalueÚ tracebackr c C s | ¡ d S r )rW )r r r r r r r Ú__exit__ s zSession.__exit__z Iterator[_S]c
|
c s. | | ¡ | V W 5 Q R X W 5 Q R X d S r ©rV rÈ r r r Ú_maker_context_manager s
|
z Session._maker_context_managerr c C s
|
| j dk S )z®Return True if this :class:`_orm.Session` has begun a transaction.
|
|
.. versionadded:: 1.4
|
|
.. seealso::
|
|
:attr:`_orm.Session.is_active`
|
|
|
N)r rÈ r r r rS s zSession.in_transactionc C s
|
| j dk S )zReturn True if this :class:`_orm.Session` has begun a nested
|
transaction, e.g. SAVEPOINT.
|
|
.. versionadded:: 1.4
|
|
N©r rÈ r r r rU ¬ s z Session.in_nested_transactionc C s$ | j }|dk r |jdk r |j}q|S )zaReturn the current root transaction in progress, if any.
|
|
.. versionadded:: 1.4
|
|
N)r r ©r rl r r r Úget_transactionµ s zSession.get_transactionc C s | j S )zcReturn the current nested transaction in progress, if any.
|
|
.. versionadded:: 1.4
|
|
r rÈ r r r Úget_nested_transactionÀ s z Session.get_nested_transactionre c C s i S )a A 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.
|
|
r rÈ r r r r É s z Session.inforx )rV r c C sL | j d krF|s | js t d¡t| |r,tjntj}| j |ksBt|S | j S )Nz]Autobegin is disabled on this Session; please call session.begin() to start a new transaction) r r rÕ rÖ rx r r r
|
r )r rV rl r r r Ú _autobegin_tÖ s
|
|
ÿÿüzSession._autobegin_tr/ c C sb | j }|dkr"| jdd}|s"|S |dk s.t|rT|j|d}| j |ksLt|| _n
|
t d¡|S )aÉ Begin a transaction, or nested transaction,
|
on this :class:`.Session`, if one is not already begun.
|
|
The :class:`_orm.Session` object features **autobegin** behavior,
|
so that normally it is not necessary to call the
|
:meth:`_orm.Session.begin`
|
method explicitly. However, it may be used in order to control
|
the scope of when the transactional state is begun.
|
|
When used to begin the outermost transaction, an error is raised
|
if this :class:`.Session` is already inside of a transaction.
|
|
:param nested: if True, begins a SAVEPOINT transaction and is
|
equivalent to calling :meth:`~.Session.begin_nested`. For
|
documentation on SAVEPOINT transactions, please see
|
:ref:`session_begin_nested`.
|
|
:return: the :class:`.SessionTransaction` object. Note that
|
:class:`.SessionTransaction`
|
acts as a Python context manager, allowing :meth:`.Session.begin`
|
to be used in a "with" block. See :ref:`session_explicit_begin` for
|
an example.
|
|
.. seealso::
|
|
:ref:`session_autobegin`
|
|
:ref:`unitofwork_transaction`
|
|
:meth:`.Session.begin_nested`
|
|
|
NTr ©r z/A transaction is already begun on this Session.)r r r r0 r rÕ rÖ )r r rl r r r rV é s # ÿz Session.beginc C s | j ddS )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.
|
|
Tr r rÈ r r r rR s zSession.begin_nestedc C s | j dkr n| j jdd dS )a{ Rollback the current transaction in progress.
|
|
If no transaction is in progress, this method is a pass-through.
|
|
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`
|
|
NTrj )r re rÈ r r r re 9 s
|
zSession.rollbackc C s& | j }|dkr| ¡ }|jdd dS )ae Flush pending changes and commit the current transaction.
|
|
When the COMMIT operation is complete, all objects are fully
|
:term:`expired`, erasing their internal contents, which will be
|
automatically re-loaded when the objects are next accessed. In the
|
interim, these objects are in an expired state and will not function if
|
they are :term:`detached` from the :class:`.Session`. Additionally,
|
this re-load operation is not supported when using asyncio-oriented
|
APIs. The :paramref:`.Session.expire_on_commit` parameter may be used
|
to disable this behavior.
|
|
When there is no transaction in place for the :class:`.Session`,
|
indicating that no operations were invoked on this :class:`.Session`
|
since the previous call to :meth:`.Session.commit`, the method will
|
begin and commit an internal-only "logical" transaction, that does not
|
normally affect the database unless pending flush changes were
|
detected, but will still invoke event handlers and object expiration
|
rules.
|
|
The outermost database transaction is committed unconditionally,
|
automatically releasing any SAVEPOINTs in effect.
|
|
.. seealso::
|
|
:ref:`session_committing`
|
|
:ref:`unitofwork_transaction`
|
|
:ref:`asyncio_orm_avoid_lazyloads`
|
|
NTrj )r r r_ r r r r r_ N s zSession.commitc C s" | j }|dkr| ¡ }| ¡ dS )ax Prepare the current transaction in progress for two phase commit.
|
|
If no transaction is in progress, this method raises an
|
:exc:`~sqlalchemy.exc.InvalidRequestError`.
|
|
Only root transactions of two phase sessions can be prepared. If the
|
current transaction is not such, an
|
:exc:`~sqlalchemy.exc.InvalidRequestError` is raised.
|
|
N)r r r\ r r r r r\ t s zSession.preparerÊ rÁ r= )r¹ r· r c C s< |r&| dd¡}|dkr.| jf |}n| ¡ }| j||dS )a" Return a :class:`_engine.Connection` object corresponding to this
|
:class:`.Session` object's transactional state.
|
|
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).
|
|
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 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`
|
|
r- N©r· )Úpopr+ r, )r r¹ r· r- r r r r.
s # þzSession.connectionrN )r: r· r r c K s, t | ¡ | j}|d kr | ¡ }| ||¡S r )r? r r r r, )r r: r· r rl r r r r, µ s
|
|
z Session._connection_for_bind.)r· r¹ rÏ Ú
|
_add_eventÚ_scalar_resultro z"Optional[_CoreSingleExecuteParams]rT r¤ )rµ rÌ r· r¹ rÏ r£ r¤ r c C s d S r r ©r rµ rÌ r· r¹ rÏ r£ r¤ r r r rÙ Â s zSession._execute_internalr¾ rË c C s d S r r r¥ r r r rÙ Ð s c C sÒ t tj|¡}|si }nt|}|j dd ¡dkrTt |d¡}t rdt
|
|t j sdt nd }| d|¡ t |¡}|r|| ¡ } n| jj} |rt| |g } | r|d k r¼| | ||||d¡\}}t| |||||| }
|
t| D ]4\} } | |
|
_| |
|
} | rØ|r| ¡ S | S qØ|
|
j}|
|
j}|d k r<| | ||||d¡\}}| j f |}| |¡}|r|st rnt t |}|j||p|i |dS |r¦| | ||pi |||¡}n|j!||p´i |d}|rÊ| ¡ S |S d S )NZcompile_state_pluginZormÚclauseTFr¡ )"rD ÚexpectrF Z StatementRolerÐ Ú_propagate_attrsrÜ rJ Z _get_plugin_class_for_pluginr rà r ZAbstractORMCompileStater Ú
|
setdefaultr< Zcoerce_to_immutabledictrÉ r Zdo_orm_executerÆ Zorm_pre_session_execrz Ú enumerater» Úscalarrµ r¸ r+ r, r r` Zorm_execute_statementÚexecute)r rµ rÌ r· r¹ rÏ r£ r¤ r rà Zorm_exec_stateÚidxÚfnZ fn_resultr- rY rä r r r rÙ Þ s¾ ÿÿ ÿ ÿ
|
|
|
|
úý
|
ù
|
|
úý
|
|
|
ÿú ÿ©r· r¹ rÏ r£ zTypedReturnsRows[_T]z
|
Result[_T])rµ rÌ r· r¹ rÏ r£ r c C s d S r r ©r rµ rÌ r· r¹ rÏ r£ r r r r¬ a s zSession.executec C s d S r r r° r r r r¬ n s c C s | j ||||||dS )aÙ Execute 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:`_engine.Connection.execute`, the :term:`2.0 style` version
|
of :class:`_engine.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.
|
|
.. seealso::
|
|
:ref:`orm_queryguide_execution_options` - ORM-specific execution
|
options
|
|
: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.
|
|
:return: a :class:`_engine.Result` object.
|
|
|
r¯ ©rÙ r° r r r r¬ { s =ú)r· r¹ zTypedReturnsRows[Tuple[_T]]z Optional[_T])rµ rÌ r· r¹ r r c K s d S r r ©r rµ rÌ r· r¹ r r r r r« Á s
|
zSession.scalarc K s d S r r r² r r r r« Í s
|
c K s | j ||f||dd|S )zÉExecute 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.
|
|
T)r· r¹ r¤ r± r² r r r r« Ù s þûúzScalarResult[_T]c K s d S r r r² r r r Úscalarsó s
|
zSession.scalarszScalarResult[Any]c K s d S r r r² r r r r³ ÿ s
|
c K s | j |f|||dd| ¡ S )a¸ Execute 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`
|
|
.. seealso::
|
|
:ref:`orm_queryguide_select_orm_entities` - contrasts the behavior
|
of :meth:`_orm.Session.execute` to :meth:`_orm.Session.scalars`
|
|
F)rÌ r· r¹ r¤ )rÙ r³ r² r r r r³ s ÿûúc C s | j dd dS )a Close 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`
|
|
F©ru N©Ú _close_implrÈ r r r rW 1 s z Session.closec C s | j dd dS )aË Close 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
|
<https://www.gevent.org/>`_, 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.
|
|
Tr´ Nrµ rÈ r r r ru Q s "zSession.invalidatert c C s0 | ¡ | jd k r,| j ¡ D ]}| |¡ q d S r )Ú expunge_allr r3 rW )r ru rZ r r r r¶ u s
|
zSession._close_implc C sF | j ¡ t| j }| j ¡ t ¡ | _ i | _i | _tj
|
|| ¡ dS )z Remove all object instances from this ``Session``.
|
|
This is equivalent to calling ``expunge(obj)`` on all objects in this
|
``Session``.
|
|
N) r> rC rÆ r Z_killr r r rJ r4 rK )r rC r r r r· { s
|
|
zSession.expunge_allÚ_SessionBindKey)r@ r- r c
|
C s¾ z t |}W nJ tjk
|
rV } z*t|ts<t d| ¡|n
|
|| j|< W 5 d }~X Y ndX trjt|tsjt t|t
|
r|| j|< n:t |r¬|| j|j < |j D ]}|| j|< qnt d| ¡d S )Nz!Not an acceptable bind target: %s)rB rÕ ÚNoInspectionAvailablerà Útyper r| r rC r rH r" r¥ Z _all_tables)r r@ r- rè ÚerrZ _selectabler r r r s*
|
ÿþ
|
|
ÿzSession._add_bindz_EntityBindKey[_O])r r- r c C s | ||¡ dS )aº Associate a :class:`_orm.Mapper` or arbitrary Python class with a
|
"bind", e.g. an :class:`_engine.Engine` or
|
:class:`_engine.Connection`.
|
|
The given entity is added to a lookup used by the
|
:meth:`.Session.get_bind` method.
|
|
:param mapper: a :class:`_orm.Mapper` object,
|
or an instance of a mapped
|
class, or any Python class that is the base of a set of mapped
|
classes.
|
|
:param bind: an :class:`_engine.Engine` or :class:`_engine.Connection`
|
object.
|
|
.. seealso::
|
|
:ref:`session_partitioning`
|
|
:paramref:`.Session.binds`
|
|
:meth:`.Session.bind_table`
|
|
|
N©r )r r r- r r r rÝ ¤ s zSession.bind_mapperrH )Útabler- r c C s | ||¡ dS )a© Associate a :class:`_schema.Table` with a "bind", e.g. an
|
:class:`_engine.Engine`
|
or :class:`_engine.Connection`.
|
|
The given :class:`_schema.Table` is added to a lookup used by the
|
:meth:`.Session.get_bind` method.
|
|
:param table: a :class:`_schema.Table` object,
|
which is typically the target
|
of an ORM mapping, or is present within a selectable that is
|
mapped.
|
|
:param bind: an :class:`_engine.Engine` or :class:`_engine.Connection`
|
object.
|
|
.. seealso::
|
|
:ref:`session_partitioning`
|
|
:paramref:`.Session.binds`
|
|
:meth:`.Session.bind_mapper`
|
|
|
Nr¼ )r r½ r- r r r Ú
|
bind_table s zSession.bind_table)r¦ r- rÍ Ú _sa_skip_for_implicit_returningz Optional[_EntityBindKey[_O]]zOptional[ClauseElement]zOptional[bool]zUnion[Engine, Connection])r r¦ r- rÍ r¿ r r c
|
K sÆ |r|S | j s| jr| jS |dkr@|dkr@| jr6| jS t d¡|dk rz t|}W q tjk
|
r } z t|trt |¡|n W 5 d}~X Y qX nd}| j rj|rÚ|j
|
j D ] } | | j kr®| j | S q®|dkrÚ|j }|dk rj|j dd¡}
|
|
|
dk r(|
|
jj
|
j D ] } | | j kr| j | S qt |¡D ]6} | | j kr2trXt| tsXt| j | S q2| jrx| jS g } |dk r| d| ¡ |dk rª| d¡ t dd | ¡ d¡dS ) aG Return a "bind" to which this :class:`.Session` is bound.
|
|
The "bind" is usually an instance of :class:`_engine.Engine`,
|
except in the case where the :class:`.Session` has been
|
explicitly bound directly to a :class:`_engine.Connection`.
|
|
For a multiply-bound or unbound :class:`.Session`, the
|
``mapper`` or ``clause`` arguments are used to determine the
|
appropriate bind to return.
|
|
Note that the "mapper" argument is usually present
|
when :meth:`.Session.get_bind` is called via an ORM
|
operation such as a :meth:`.Session.query`, each
|
individual INSERT/UPDATE/DELETE operation within a
|
:meth:`.Session.flush`, call, etc.
|
|
The order of resolution is:
|
|
1. if mapper given and :paramref:`.Session.binds` is present,
|
locate a bind based first on the mapper in use, then
|
on the mapped class in use, then on any base classes that are
|
present in the ``__mro__`` of the mapped class, from more specific
|
superclasses to more general.
|
2. if clause given and ``Session.binds`` is present,
|
locate a bind based on :class:`_schema.Table` objects
|
found in the given clause present in ``Session.binds``.
|
3. if ``Session.binds`` is present, return that.
|
4. if clause given, attempt to return a bind
|
linked to the :class:`_schema.MetaData` ultimately
|
associated with the clause.
|
5. if mapper given, attempt to return a bind
|
linked to the :class:`_schema.MetaData` ultimately
|
associated with the :class:`_schema.Table` or other
|
selectable to which the mapper is mapped.
|
6. No bind can be found, :exc:`~sqlalchemy.exc.UnboundExecutionError`
|
is raised.
|
|
Note that the :meth:`.Session.get_bind` method can be overridden on
|
a user-defined subclass of :class:`.Session` to provide any kind
|
of bind resolution scheme. See the example at
|
:ref:`session_custom_partitioning`.
|
|
:param mapper:
|
Optional mapped class or corresponding :class:`_orm.Mapper` instance.
|
The bind can be derived from a :class:`_orm.Mapper` first by
|
consulting the "binds" map associated with this :class:`.Session`,
|
and secondly by consulting the :class:`_schema.MetaData` associated
|
with the :class:`_schema.Table` to which the :class:`_orm.Mapper` is
|
mapped for a bind.
|
|
:param clause:
|
A :class:`_expression.ClauseElement` (i.e.
|
:func:`_expression.select`,
|
:func:`_expression.text`,
|
etc.). If the ``mapper`` argument is not present or could not
|
produce a bind, the given expression construct will be searched
|
for a bound element, typically a :class:`_schema.Table`
|
associated with
|
bound :class:`_schema.MetaData`.
|
|
.. seealso::
|
|
:ref:`session_partitioning`
|
|
:paramref:`.Session.binds`
|
|
:meth:`.Session.bind_mapper`
|
|
:meth:`.Session.bind_table`
|
|
NzlThis session is not bound to a single Engine or Connection, and no context was provided to locate a binding.Úplugin_subjectzmapper zSQL expressionz&Could not locate a bind configured on ú, z or this Session.)r| r- rÕ ZUnboundExecutionErrorrB r¹ rà rº r ZUnmappedClassErrorr¥ Ú__mro__Zpersist_selectabler¨ rÜ r rI Ziterater rK r rØ Újoin) r r r¦ r- rÍ r¿ r Zinspected_mapperr» r rÀ Úobjr r r r r+ Þ sb T ÿ
|
|
|
ÿ
|
|
|
|
ÿzSession.get_bindz_EntityType[_O]z Query[_O])Ú_entityr c C s d S r r )r rÅ r r r r }
|
s z Session.queryzTypedColumnsClauseRole[_T]z RowReturningQuery[Tuple[_T]])Ú_colexprr c C s d S r r )r rÆ r r r r
|
s z
|
_TCCA[_T0]z
|
_TCCA[_T1]z"RowReturningQuery[Tuple[_T0, _T1]])Ú_Session__ent0Ú_Session__ent1r c C s d S r r )r rÇ rÈ r r r r
|
s z
|
_TCCA[_T2]z'RowReturningQuery[Tuple[_T0, _T1, _T2]])rÇ rÈ Ú_Session__ent2r c C s d S r r )r rÇ rÈ rÉ r r r r
|
s z
|
_TCCA[_T3]z,RowReturningQuery[Tuple[_T0, _T1, _T2, _T3]])rÇ rÈ rÉ Ú_Session__ent3r c C s d S r r )r rÇ rÈ rÉ rÊ r r r r
|
s z
|
_TCCA[_T4]z1RowReturningQuery[Tuple[_T0, _T1, _T2, _T3, _T4]])rÇ rÈ rÉ rÊ Ú_Session__ent4r c C s d S r r )r rÇ rÈ rÉ rÊ rË r r r r ¢
|
s z
|
_TCCA[_T5]z6RowReturningQuery[Tuple[_T0, _T1, _T2, _T3, _T4, _T5]])rÇ rÈ rÉ rÊ rË Ú_Session__ent5r c C s d S r r )r rÇ rÈ rÉ rÊ rË rÌ r r r r
|
s
|
z
|
_TCCA[_T6]z;RowReturningQuery[Tuple[_T0, _T1, _T2, _T3, _T4, _T5, _T6]])rÇ rÈ rÉ rÊ rË rÌ Ú_Session__ent6r c C s d S r r )r rÇ rÈ rÉ rÊ rË rÌ rÍ r r r r ¹
|
s z
|
_TCCA[_T7]z@RowReturningQuery[Tuple[_T0, _T1, _T2, _T3, _T4, _T5, _T6, _T7]]) rÇ rÈ rÉ rÊ rË rÌ rÍ Ú_Session__ent7r c C s d S r r ) r rÇ rÈ rÉ rÊ rË rÌ rÍ rÎ r r r r Æ
|
s z_ColumnsClauseArgument[Any]z
|
Query[Any])Úentitiesr* r c O s d S r r ©r rÏ r* r r r r Ö
|
s c O s | j || f|S )a¯ Return a new :class:`_query.Query` object corresponding to this
|
:class:`_orm.Session`.
|
|
Note that the :class:`_query.Query` object is legacy as of
|
SQLAlchemy 2.0; the :func:`_sql.select` construct is now used
|
to construct ORM queries.
|
|
.. seealso::
|
|
:ref:`unified_tutorial`
|
|
:ref:`queryguide_toplevel`
|
|
:ref:`query_api_toplevel` - legacy API doc
|
|
)r rÐ r r r r Ü
|
s r r£ r. rõ z)Union[Optional[_O], LoaderCallableStatus])r Úprimary_key_identityr¢ Úpassiver÷ r· r¹ r c
|
C s" |j ||d}t | |||¡} | S )az Locate an object in the identity map.
|
|
Given a primary key identity, constructs an identity key and then
|
looks in the session's identity map. If present, the object may
|
be run through unexpiration rules (e.g. load unloaded attributes,
|
check if was deleted).
|
|
e.g.::
|
|
obj = session._identity_lookup(inspect(SomeClass), (1, ))
|
|
:param mapper: mapper in use
|
:param primary_key_identity: the primary key we are searching for, as
|
a tuple.
|
:param identity_token: identity token that should be used to create
|
the identity key. Used as is, however overriding subclasses can
|
repurpose this in order to interpret the value in a special way,
|
such as if None then look among multiple target tokens.
|
:param passive: passive load flag passed to
|
:func:`.loading.get_from_identity`, which impacts the behavior if
|
the object is found; the object may be validated and/or unexpired
|
if the flag allows for SQL to be emitted.
|
:param lazy_loaded_from: an :class:`.InstanceState` that is
|
specifically asking for this identity as a related identity. Used
|
for sharding schemes where there is a correspondence between an object
|
and a related object being lazy-loaded (or otherwise
|
relationship-loaded).
|
|
:return: None if the object is not found in the identity map, *or*
|
if the object was unexpired and found to have been deleted.
|
if passive flags disallow SQL and the object is expired, returns
|
PASSIVE_NO_RESULT. In all other cases the instance is returned.
|
|
.. versionchanged:: 1.4.0 - the :meth:`.Session._identity_lookup`
|
method was moved from :class:`_query.Query` to
|
:class:`.Session`, to avoid having to instantiate the
|
:class:`_query.Query` object.
|
|
|
)r¢ )Z identity_key_from_primary_keyr Zget_from_identity)
|
r r rÑ r¢ rÒ r÷ r· r¹ r@ Z return_valuer r r Ú_identity_lookupò
|
s 3 ÿzSession._identity_lookupzIterator[Session]c c s$ | j }d| _ z
|
| V W 5 || _ X dS )ag Return a context manager that disables autoflush.
|
|
e.g.::
|
|
with session.no_autoflush:
|
|
some_object = SomeClass()
|
session.add(some_object)
|
# won't autoflush
|
some_object.related_thing = session.query(SomeRelated).first()
|
|
Operations that proceed within the ``with:`` block
|
will not be subject to flushes occurring upon query
|
access. This is useful when initializing a series
|
of objects which involve existing database queries,
|
where the uncompleted object should not yet be flushed.
|
|
FN)r )r r r r r Ú no_autoflush- s
|
|
zSession.no_autoflushzThis warning originated from the Session 'autoflush' process, which was invoked automatically in response to a user-initiated operation.c
|
C s^ | j rZ| jsZz | ¡ W n@ tjk
|
rX } z | d¡ | t ¡ d ¡W 5 d }~X Y nX d S )Nzraised as a result of Query-invoked autoflush; consider using a session.no_autoflush block if this flush is occurring prematurelyr9 ) r r4 r5 rÕ ZStatementErrorZ
|
add_detailrq ro rp )r Úer r r Ú
|
_autoflushI s ÿzSession._autoflushr¨ zOptional[Iterable[str]]rs )r Úattribute_namesÚwith_for_updater c C s¶ zt |¡}W n0 tjk
|
r> } zt |¡|W 5 d}~X Y nX | ||¡ | ¡ |i krft d¡t
|
|¡}t t |¡}tj| ||j|||dddd dkr²t dt| ¡dS )a 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.
|
|
.. versionadded:: 1.4 - the :meth:`_orm.Session.refresh` method
|
can also refresh eagerly loaded attributes.
|
|
:func:`_orm.relationship` oriented attributes that would normally
|
load using the ``select`` (or "lazy") loader strategy will also
|
load **if they are named explicitly in the attribute_names
|
collection**, emitting a SELECT statement for the attribute using the
|
``immediate`` loader strategy. If lazy-loaded relationships are not
|
named in :paramref:`_orm.Session.refresh.attribute_names`, then
|
they remain as "lazy loaded" attributes and are not implicitly
|
refreshed.
|
|
.. versionchanged:: 2.0.4 The :meth:`_orm.Session.refresh` method
|
will now refresh lazy-loaded :func:`_orm.relationship` oriented
|
attributes for those which are named explicitly in the
|
:paramref:`_orm.Session.refresh.attribute_names` collection.
|
|
.. 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 <orm_queryguide_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.
|
|
Nzqwith_for_update should be the boolean value True, or a dictionary with options. A blank dictionary is ambiguous.T)Z refresh_staterØ Zonly_load_propsZrequire_pk_colsrÔ Zis_user_refreshz Could not refresh instance '%s')r Úinstance_stater ÚNO_STATEÚUnmappedInstanceErrorÚ _expire_staterÖ rÕ r rL Ú_from_argumentr; Úselectr, r Z load_on_identr@ rÖ r* )r r r× rØ r r» Zstmtr r r Úrefresh_ s: K ÿ
|
ôòÿ
|
ÿzSession.refreshc C s& | j ¡ D ]}| |j| j j¡ q
|
dS )aÊ Expires 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` is not usually needed,
|
assuming the transaction is isolated.
|
|
.. seealso::
|
|
:ref:`session_expire` - introductory material
|
|
:meth:`.Session.expire`
|
|
:meth:`.Session.refresh`
|
|
:meth:`_orm.Query.populate_existing`
|
|
N)r> rC rE rÐ rF ©r r r r r Ú
|
expire_allØ s zSession.expire_all)r r× r c
|
C sP zt |¡}W n0 tjk
|
r> } zt |¡|W 5 d}~X Y nX | ||¡ dS )aÀ Expire 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`
|
|
N)r rÙ r rÚ rÛ rÜ )r r r× r r» r r r Úexpireû s
|
' zSession.expirer )r r× r c C s\ | |¡ |r | |j|¡ n:t|jj d|¡}| |¡ |D ]\}}}}| |¡ q@d S )Nzrefresh-expire)Ú_validate_persistentÚ_expire_attributesrÐ rÆ Úmanagerr Úcascade_iteratorÚ_conditional_expire)r r r× ÚcascadedÚoÚmÚst_Údct_r r r rÜ ( s
|
ÿ
|
zSession._expire_state)r r r c C s> |j r| |j| jj¡ n || jkr:| j |¡ | | ¡ dS )z5Expire a state if persistent, else expunge if pendingN)r@ rE rÐ r> rF r r¢ Z_detach)r r r r r r rç : s
|
|
zSession._conditional_expirer© c
|
C s zt |¡}W n0 tjk
|
r> } zt |¡|W 5 d}~X Y nX |j| jk r^t dt | ¡t
|
|j j d|¡}| |gdd |D ¡ dS )zÃRemove the `instance` from this ``Session``.
|
|
This will free all internal references to the instance. Cascading
|
will be applied according to the *expunge* cascade rule.
|
|
Nz*Instance %s is not present in this SessionÚexpungec S s g | ]\}}}}|qS r r )r ré rê rë rì r r r r X s
|
z#Session.expunge.<locals>.<listcomp>)r rÙ r rÚ rÛ Ú
|
session_idr~ rÕ rÖ r/ rÆ rå r ræ r< )r r r r» rè r r r rí E s
|
ÿÿzSession.expungez Iterable[InstanceState[Any]])Ústatesr: r c C sv |D ]Z}|| j kr | j |¡ q| j |¡rH| j |¡ | j |d ¡ q| jr| jj |d ¡ qtjj || |d d S )Nr9 )
|
r r¢ r> Úcontains_stater? r r rJ r4 rK )r rï r: r r r r r< Z s
|
ÿzSession._expunge_stateszSet[InstanceState[Any]])rï r c
|
C s | j jp
|
d}|D ]}t|}| ¡ }|dk r| |¡}t |d ¡rL|jrZt |d ¡rlt
|
dt | ¡|j dkr~||_ n\|j |krÚ| j |¡ | j}|dk s¦t||jkrÀ|j| d }n|j }||f|j|< ||_ | j |¡} | dk r | | ¡|kr | ¡ dk r t d|f ¡ d|_qtj dd |D | j ¡ | |¡ |dk rr| | j¡D ]}|| | q`t| | j¡D ]}| j |¡ qdS ) z´Register all persistent objects from a flush.
|
|
This is used both for pending objects moving to the persistent
|
state as well as already persistent objects.
|
|
Nr aO Instance %s has a NULL identity key. If this is an auto-generated value, check that the database table allows generation of new primary key values, and that the mapped Column object is configured to expect these generated values. Ensure also that this flush() is not occurring at an inappropriate time, such as within a load() event.r z§Identity map already had an identity for %s, replacing it with newly flushed object. Are there load operations occurring inside of an event handler within the flush?Fc s s | ]}||j fV qd S r ©rÐ ©r r r r r Ú <genexpr>² s z/Session._register_persistent.<locals>.<genexpr>) r Úpending_to_persistentr) rÄ Ú_identity_key_from_stater( Ú intersectionÚallow_partial_pksÚ
|
issupersetr rb r/ r@ r> r? r r r rA r< rO Ú _orphaned_outside_of_sessionrJ r4 Ú_commit_all_statesÚ_register_alteredr rá r¢ )
|
r rï rô r r rÄ Z instance_keyrl Zorig_keyÚoldr r r Ú_register_persistentk sj
|
|
ÿþ ýùÿ
|
|
|
þ
|
ÿ þ
|
ýýÿ ÿ
|
|
z Session._register_persistentc C s8 | j r4|D ](}|| jkr&d| j j|< q
|
d| j j|< q
|
d S ©NT)r r r )r rï r r r r rû ¿ s
|
|
zSession._register_alteredc C sn | j jp
|
d }|D ]X}| jr&d| jj|< |d k r6| ¡ }| j |¡ | j |d ¡ d|_|d k r|| | qd S rþ )r Úpersistent_to_deletedr r rÄ r> r? r¢ )r rï rÿ r rÄ r r r Ú_remove_newly_deletedÇ s z Session._remove_newly_deleted)r Ú_warnr c
|
C sb |r| j r| d¡ zt |¡}W n0 tjk
|
rR } zt |¡|W 5 d}~X Y nX | |¡ dS )a Place 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()N)r} Ú_flush_warningr rÙ r rÚ rÛ Ú_save_or_update_state)r r r r r» r r r râ Ý s
|
|
z Session.addzIterable[object])Ú instancesr c C s, | j r| d¡ |D ]}| j|dd qdS )a2 Add 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)r N)r} r râ )r r r r r r Úadd_all s
|
zSession.add_allr c C sF d|_ | |¡ t|}|jd|| jdD ]\}}}}| |¡ q*d S )NFz save-update)Zhalt_on)rù Ú_save_or_update_implr) ræ Ú_contains_state)r r r ré rê rë rì r r r r s
|
ÿz Session._save_or_update_statec
|
C sd | j r| d¡ zt |¡}W n0 tjk
|
rN } zt |¡|W 5 d}~X Y nX | j||dd dS )aV Mark 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()NT)Úhead)r} r r rÙ r rÚ rÛ Ú _delete_impl©r r r r» r r r Údelete s
|
zSession.delete)r rÄ r r c
|
C s¼ |j d kr&|r"t dt| ¡nd S | ||¡}|| jkr@d S | j |¡ |r\| ||¡ |rvt |j
|
j d|¡}nd }|| j|< |r¸t r|d k st|D ]\}}}} | ||d¡ qd S )Nú Instance '%s' is not persistedr F)r@ rÕ rÖ r/ Ú_before_attachr r> râ Ú _after_attachrÆ rå r ræ r r r )
|
r r rÄ r Ú to_attachZcascade_statesré rê rë rì r r r r = s.
|
|
ÿ
|
ÿ
|
zSession._delete_impl©ÚoptionsÚpopulate_existingrØ r¢ r· r¹ Ú_PKIdentityArgumentz Optional[Sequence[ORMOption]]z Optional[_O]) rÞ r¦ r r rØ r¢ r· r¹ r c C s | j ||tj||||||d S )aû Return 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 legacy :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
|
|
: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.
|
|
.. versionadded: 2.0.0rc1
|
|
:return: The object instance, or ``None``.
|
|
r )Ú _get_implr Zload_on_pk_identity) r rÞ r¦ r r rØ r¢ r· r¹ r r r rÜ e s r÷z Session.getzCallable[..., _O]z$Optional[Sequence[ExecutableOption]])
|
rÞ rÑ Ú
|
db_load_fnr r rØ r¢ r· r¹ r c
|
s
|
t r,t tjkr,tjt }
|
|
|
t|} | d ksB| jsPt d| ¡t t } | snt
|
j d gd t t | j kr t dd dd | j D ¡ ¡| rH| j} | rät| ¡}|rät |D ]} | | | < qÎz t fdd| jD W nF tk
|
rF } z&t dd d d | jD ¡ ¡|W 5 d }~X Y nX |s¤| js¤|d kr¤| j| ||| d
|
}|d k rt|| jsd S |S |tjk s¤tt j j }|r¾|d |i7 }t | ¡ !t"¡}|d k rät# $|¡|_%|rô|j&| }|| | |||| d S ) Nz(Expected mapped class or mapper, got: %r)ÚdefaultzoIncorrect number of values in identifier to formulate primary key for session.get(); primary key columns are %sú,c s s | ]}d | V qdS ©z'%s'Nr )r Úcr r r ró s z$Session._get_impl.<locals>.<genexpr>c 3 s | ]} |j V qd S r ©r@ ©r Úprop©rÑ r r ró ! s ÿzIncorrect names of values in identifier to formulate primary key for session.get(); primary key attribute names are %s (synonym names are also accepted)c s s | ]}d |j V qdS r r r r r r ró + s ÿ)r¢ r· r¹ Z_populate_existing)rö r¢ r· r¹ )'r# rº r Z_composite_gettersrB Z is_mapperrÕ r rà rÐ r< Zto_listr× Z primary_keyrÖ rà Z _pk_synonymsrá rö rÆ Z_identity_key_propsÚKeyErrorZalways_refreshrÓ r¥ r+ ZPASSIVE_CLASS_MISMATCHr r rü rý r; rÞ Zset_label_stylerM rL rÝ Z_for_update_argr )r rÞ rÑ r r r rØ r¢ r· r¹ Úgetterr Zis_dictZ pk_synonymsZ correct_keysÚkr» r rö rµ r r r r ã sº ÿÿþÿÿ
|
ÿþÿÿþÿ þ
|
þýÿø ÿþýû
|
|
ÿ
|
ÿ
|
ùzSession._get_impl)Úloadr r! )r r! r r c C sl | j r| d¡ i }i }|r$| ¡ t| | j}z,d| _| jt |¡t |¡||||dW ¢S || _X dS )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.
|
|
: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)r! r Ú
|
_recursiveÚ_resolve_conflict_mapN) r} r rÖ r, r Ú_merger rÙ Ú instance_dict)r r r! r r" r# r r r r Úmergee s& >
|
ú
|
z Session.merge)r úInstanceState[_O]rS zDict[Any, object]z#Dict[_IdentityKeyType[Any], object])r Ú
|
state_dictr r! r" r# r c C s¶ t |}||kr tt|| S d}|j} | d kr|| jkrLt dt| ¡ |sZt d¡|
|
|¡} t j | d kot | d ¡ p|jot | d ¡ }
|
nd}
|
| | jkrÒz| j| } W qÖ tk
|
rÎ d } Y qÖX nd } | d kr`|
|
rü| |krütt|| } nd|s>|jrt d¡|j ¡ } t | ¡} | | _| | ¡ d}n"|
|
r`| j|j| d | d |d} | d kr|j ¡ } t | ¡} t | ¡} d}| | ¡ nt | ¡} t | ¡} | ||< | || < || k rx|j d k r8|j |||j t j d }|j | | |j t j d }|t j!k r8|t j!k r8||kr8t" #d
|
|t| |f ¡|j$| _$|j%| _%| &|¡ |j'D ] }| (| ||| | |||¡ qX|s| )| | j¡ | j*j+ ,| d ¡ |r²| j*j+ -| d ¡ | S ) NFzrInstance %s is already pending in this Session yet is being merged again; this is probably not what you want to doz¦merge() with load=False option does not support objects transient (i.e. unpersisted) objects. flush() all changes on mapped instances before merging with load=False.r Tzmerge() with load=False option does not support objects marked as 'dirty'. flush() all changes on mapped instances before merging with load=False.r9 )r¢ r ©rÒ zVersion id '%s' on merged state %s does not match existing version '%s'. Leave the version attribute unset when merging to update the most recent version.).r) r r! r@ r r< rO r/ rÕ rÖ rõ r+ Z NEVER_SETr( rö r÷ rø r> r rD Z class_managerÚ new_instancer rÙ rB rÜ r¥ r% r Zversion_id_colZ_get_state_attr_by_columnr. ZPASSIVE_NO_INITIALIZEZPASSIVE_NO_RESULTr ZStaleDataErrorZ load_pathrö Z_copy_callablesZiterate_propertiesr& Ú _commit_allrå r Z_sa_event_merge_wo_loadr! )r r r( r r! r" r# r r* r@ Zkey_is_persistentÚmergedZ merged_stateZ merged_dictÚexisting_versionZmerged_versionr r r r r$ ¼ sè
|
|
þÿÿ
|
ÿú
|
|
|
ÿ
|
|
|
ü
|
|
|
|
|
|
|
üüÿÿÿýûýüÿ
|
|
ø ÿzSession._mergec C s" | j |¡s t dt| ¡d S )Nz3Instance '%s' is not persistent within this Session)r> rð rÕ rÖ r/ rà r r r rã b s ÿÿz Session._validate_persistentc C sd |j d k r t dt| ¡| ¡ }| ||¡}|| jkrP|| j|< t| j|_|r`| ||¡ d S )NzGObject '%s' already has an identity - it can't be registered as pending)
|
r@ rÕ rÖ r/ rÄ r r r× Z insert_orderr )r r rÄ r r r r Ú
|
_save_impli s
|
ÿÿ
|
|
zSession._save_impl)r r; r c C s¼ |j d kr t dt| ¡|jrH|r6|js0d S |`nt dt| ¡| ¡ }|d kr\d S | ||¡}| j |d ¡ |r| j
|
|¡ n | j |¡ |r¦| ||¡ n|r¸| j | |¡ d S )Nr zsInstance '%s' has been deleted. Use the make_transient() function to send this object back to the transient state.)r@ rÕ rÖ r/ r Z _attachedrÄ r r¢ r> rA râ r r Zdeleted_to_persistent)r r r; rÄ r r r r rB x s4
|
|
ÿýÿ zSession._update_implc C s$ |j d kr| |¡ n
|
| |¡ d S r )r@ r. rB rà r r r r s
|
z Session._save_or_update_impl)rÄ r c
|
C sf zt |¡}W n0 tjk
|
r> } zt |¡|W 5 d}~X Y nX | ||¡}d|_|rb| ||¡ dS )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.
|
|
NT)r rÙ r rÚ rÛ r Z _load_pendingr )r rÄ r r» r r r r Úenable_relationship_loading¦ s 7 z#Session.enable_relationship_loading)r rÄ r c C sV | ¡ |j| jkrdS |jrD|jtkrDt dt||j| jf ¡| j | |¡ dS )NFz>Object '%s' is already attached to session '%s' (this is '%s')T) r rî r~ r rÕ rÖ r/ r Z before_attach©r r rÄ r r r r ç s þÿzSession._before_attachc C sT | j |_|jr |jd kr ||_| j | |¡ |jrB| j | |¡ n| j | |¡ d S r ) r~ rî rD Z _strong_objr Z after_attachr@ Zdetached_to_persistentZtransient_to_pendingr0 r r r r ø s zSession._after_attachc
|
C sJ zt |¡}W n0 tjk
|
r> } zt |¡|W 5 d}~X Y nX | |¡S )zªReturn True if the instance is associated with this session.
|
|
The instance may be pending or persistent within the Session for a
|
result of True.
|
|
N)r rÙ r rÚ rÛ r r
|
r r r Ú __contains__ s
|
zSession.__contains__zIterator[object]c C s t t| j ¡ t| j ¡ S )zWIterate over all pending or persistent instances within this
|
Session.
|
|
)ÚiterrÆ r rc r> rÈ r r r Ú__iter__ s ÿzSession.__iter__c C s || j kp| j |¡S r )r r> rð rà r r r r s zSession._contains_statezOptional[Sequence[Any]])Úobjectsr c C s> | j rt d¡| ¡ r dS zd| _ | |¡ W 5 d| _ X dS )aí Flush 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.
|
|
: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 flushingNFT)r4 rÕ rÖ ra Ú_flush)r r4 r r r r5 s
|
z Session.flush)Úmethodr c C s t d| ¡ d S )NzÚUsage 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.)r< rO )r r6 r r r r > s
|
ýÿzSession._flush_warningc C s | j ¡ o| j o| j S r )r> Zcheck_modifiedr r rÈ r r r ra F s
|
ÿýzSession._is_cleanzOptional[Sequence[object]]c C s¢ | j }|s&| js&| js&| jj ¡ d S t| }| jjrL| j | ||¡ | j }t | j}t | j}t |
|
|¡}|rÎt }|D ]N}zt |¡}W n0 t jk
|
r¾ } zt |¡| W 5 d } ~ X Y nX | |¡ q|nd }t }
|
|rô| |¡ |¡
|
|¡} n| |¡
|
|¡} | D ]h}t| |¡} | o$|j} | rH| sH|jrH| |g¡ n&|j|| d}|sdtd|
|
|¡ q|r| |¡
|
|
|
¡} n
|
|
|
|
|
¡} | D ]"}|j|dd}|stdq|jsÈd S | ¡ ¡ |_ }zd| _ z | ¡ W 5 d| _ X | j | |¡ | !¡ |sX| jjrXt"| jj}t#j$j%dd | jjD | jd t& 'd| ¡ | j (| |¡ | )¡ W n, t& *¡ |j+dd W 5 Q R X Y nX d S )
|
N)Zisdeletez*Failed to add object to the flush context!TFc S s g | ]}||j fqS r rñ rò r r r r § s ÿz"Session._flush.<locals>.<listcomp>)r% zÿAttribute 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.©rn ),Ú _dirty_statesr r r> rF rL r8 r Z before_flushrá Ú
|
differencer rÙ r rÚ rÛ râ rÅ rö r) Z
|
_is_orphanZ has_identityrù r< Zregister_objectr Zhas_workr r0 rZ r} r¬ Z after_flushZfinalize_flush_changesr× rJ r4 rú r< rO Zafter_flush_postexecr_ rd re )r r4 ÚdirtyZ flush_contextÚdeletedÚnewZobjsetré r r» Ú processedÚprocZ is_orphanZis_persistent_orphanZ_regrZ Zlen_r r r r5 M s
|
|
ÿþý ÿ
|
þûûÿ
|
zSession._flush)r4 Úreturn_defaultsÚupdate_changed_onlyÚpreserve_orderr c
|
|
C sf dd |D }|s"t |dd d}dddd d
|
}t ||¡D ]"\\}}} | || |d ||d ¡ q>d S )a Perform a bulk save of the given list of objects.
|
|
.. legacy::
|
|
This method is a legacy feature as of the 2.0 series of
|
SQLAlchemy. For modern bulk INSERT and UPDATE, see
|
the sections :ref:`orm_queryguide_bulk_insert` and
|
:ref:`orm_queryguide_bulk_update`.
|
|
For general INSERT and UPDATE of existing ORM mapped objects,
|
prefer standard :term:`unit of work` data management patterns,
|
introduced in the :ref:`unified_tutorial` at
|
:ref:`tutorial_orm_data_manipulation`. SQLAlchemy 2.0
|
now uses :ref:`engine_insertmanyvalues` with modern dialects
|
which solves previous issues of bulk INSERT slowness.
|
|
: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.
|
|
.. seealso::
|
|
:doc:`queryguide/dml`
|
|
:meth:`.Session.bulk_insert_mappings`
|
|
:meth:`.Session.bulk_update_mappings`
|
|
c s s | ]}t |¡V qd S r )r rÙ )r rÄ r r r ró s z,Session.bulk_save_objects.<locals>.<genexpr>c S s t | j| jd k fS r )Úidr r@ r r r r Ú<lambda> ó z+Session.bulk_save_objects.<locals>.<lambda>r r' zTuple[Mapper[_O], bool]r c S s | j | jd k fS r )r r@ r r r r Ú grouping_key s z/Session.bulk_save_objects.<locals>.grouping_keyTFN)ÚsortedrÓ ÚgroupbyÚ_bulk_save_mappings)
|
r r4 r? r@ rA Z
|
obj_statesrE r Úisupdaterï r r r Úbulk_save_objectsÅ s( Kþ ÿùzSession.bulk_save_objectsr zIterable[Dict[str, Any]])r Úmappingsr? Ú render_nullsr c C s | ||dd|d|¡ dS )a= Perform a bulk insert of the given list of mapping dictionaries.
|
|
.. legacy::
|
|
This method is a legacy feature as of the 2.0 series of
|
SQLAlchemy. For modern bulk INSERT and UPDATE, see
|
the sections :ref:`orm_queryguide_bulk_insert` and
|
:ref:`orm_queryguide_bulk_update`. The 2.0 API shares
|
implementation details with this method and adds new features
|
as well.
|
|
: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, the INSERT process will be altered
|
to ensure that newly generated primary key values will be fetched.
|
The rationale for this parameter is typically to enable
|
:ref:`Joined Table Inheritance <joined_inheritance>` mappings to
|
be bulk inserted.
|
|
.. note:: for backends that don't support RETURNING, the
|
:paramref:`_orm.Session.bulk_insert_mappings.return_defaults`
|
parameter can significantly decrease performance as INSERT
|
statements can no longer be batched. See
|
:ref:`engine_insertmanyvalues`
|
for background on which backends are affected.
|
|
: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.
|
|
.. seealso::
|
|
:doc:`queryguide/dml`
|
|
:meth:`.Session.bulk_save_objects`
|
|
:meth:`.Session.bulk_update_mappings`
|
|
FN©rH )r r rK r? rL r r r Úbulk_insert_mappings. s Iùz Session.bulk_insert_mappings)r rK r c C s | ||ddddd¡ dS )aa Perform a bulk update of the given list of mapping dictionaries.
|
|
.. legacy::
|
|
This method is a legacy feature as of the 2.0 series of
|
SQLAlchemy. For modern bulk INSERT and UPDATE, see
|
the sections :ref:`orm_queryguide_bulk_insert` and
|
:ref:`orm_queryguide_bulk_update`. The 2.0 API shares
|
implementation details with this method and adds new features
|
as well.
|
|
: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::
|
|
:doc:`queryguide/dml`
|
|
:meth:`.Session.bulk_insert_mappings`
|
|
:meth:`.Session.bulk_save_objects`
|
|
TFNrM )r r rK r r r Úbulk_update_mappings s & ÿz Session.bulk_update_mappingsz<Union[Iterable[InstanceState[_O]], Iterable[Dict[str, Any]]])r rK rI Úisstatesr? r@ rL r c C s t |}d| _| ¡ ¡ }zjz8|r6t |||||¡ nt ||||||¡ | ¡ W n, t ¡ |j
|
dd W 5 Q R X Y nX W 5 d| _X d S )NTFr7 ) r' r4 r r0 r Z _bulk_updateZ _bulk_insertr_ r< rd re ) r r rK rI rP r? r@ rL rZ r r r rH « s2
|
ûú
|
zSession._bulk_save_mappings)r Úinclude_collectionsr c C sp t |}|jsdS |j}|jjD ]J}|s4t|jds t|jdsBq |jj||tj d\}}}|sd|r dS q dS )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.
|
|
FZget_collectionÚ get_historyr) TN)
|
r- rD rÐ rå r ÚhasattrÚimplrR r. rz ) r r rQ r Zdict_ÚattrÚaddedZ unchangedr; r r r Ú is_modifiedÓ s( 5 ÿ
|
þ
|
ý ÿ zSession.is_modifiedc C s | j dkp| j jS )a4 True 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)r r' rÈ r r r r' s zSession.is_activec C s
|
| j ¡ S )z«The set of all persistent states considered dirty.
|
|
This method returns all states that were modified including
|
those that were possibly deleted.
|
|
)r> r8 rÈ r r r r8 = s zSession._dirty_statesrN c s t fdd jD S )aZ The 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.
|
|
c s g | ]}| j kr| ¡ qS r )r rÄ rò rÈ r r r ` s
|
þz!Session.dirty.<locals>.<listcomp>)rN r8 rÈ r rÈ r r: G s
|
|
þÿz Session.dirtyc C s t t| j ¡ ¡S )zDThe set of all instances marked as 'deleted' within this ``Session``)r< rN rÆ r rc rÈ r r r r; g s zSession.deletedc C s t t| j ¡ ¡S )zAThe set of all instances marked as 'new' within this ``Session``.)r< rN rÆ r rc rÈ r r r r< m s z Session.new)N)F)F)NN)N)N)N)N)N)N)N)N)N)N)N)N)N)N)NN)N)N)F)T)F)N)N)FTT)FF)T)br r r r Z _is_asyncior rÇ r r r r Ú
|
contextlibÚcontextmanagerr rS rU r r r< Zmemoized_propertyr r rV rR re r_ r\ r. r, r Ú
|
EMPTY_DICTrÙ r¬ r« r³ rW ru r¶ r· r rÝ r¾ r+ r r. Z PASSIVE_OFFrÓ Znon_memoized_propertyrÔ Z langhelpersZtag_method_for_warningsrÕ Z SAWarningrÖ rß rá râ rÜ rç rí r< rý rû r râ r r r r rÜ r r& r$ rã r. rB r r/ r r r1 r3 r r5 r ra r5 rJ rN rO rH rW r r' r8 r: r; r< r r r r rw P s
|
þò( 7& ý3ý ý÷" ý÷"ý÷ ýø ýø ýø Fýú ýú ýú ýú ýú ýú & $ þù
|
|
ø ;ü üy$ÿ-ÿ ÿT#
|
-ö0 õ4 û&\û2 'ÿ(A " { û m û"S *$)ÿL r c
|
@ sÌ e Zd ZU dZded< ed#dddddddddd d
|
d d Zed$ddddd ddddd ddd Zd%edddddddddd d
|
dd ZddddZd ddddZ d d d d d Z
|
d dd!d"Z dS )&ry 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+psycopg2://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`.
|
|
zType[_S]r¥ .)r rI r r rê r r )r- r¥ r rI r r c K s d S r r ©r r- r¥ r rI r r r r r rÇ Ø s zsessionmaker.__init__z'sessionmaker[Session]'©r r- r rI r r c K s d S r r r\ r r r rÇ å s
|
NT)r¥ r rI r c K sD ||d< ||d< ||d< |dk r(||d< || _ t|j|fi | _dS )a< Construct 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.
|
|
.. seealso::
|
|
:ref:`session_flushing` - additional background on autoflush
|
|
: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.
|
|
r- r rI Nr )r rº r r¥ r[ r r r rÇ ñ s )z%contextlib.AbstractContextManager[_S]r c C s | }| ¡ S )am Produce 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
|
|
|
)r )r r r r r rV $ s zsessionmaker.beginr )Úlocal_kwr c K s\ | j ¡ D ]D\}}|dkrBd|krB| ¡ }| |d ¡ ||d< q
|
| ||¡ q
|
| jf |S )ap Produce 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(some_engine)
|
session = Session() # invokes sessionmaker.__call__()
|
|
r )r r= ÚcopyrÑ r© r¥ )r r] r Úvræ r r r r : s
|
zsessionmaker.__call__r )Únew_kwr c K s | j |¡ dS )z±(Re)configure the arguments for this sessionmaker.
|
|
e.g.::
|
|
Session = sessionmaker()
|
|
Session.configure(bind=create_engine('sqlite://'))
|
N)r rÑ )r r` r r r Ú configureN s zsessionmaker.configurer! c C s, d| j j| jjd dd | j ¡ D ¡f S )Nz%s(class_=%r, %s)rÁ c s s | ]\}}d ||f V qdS )z%s=%rNr )r r r_ r r r ró ] s z(sessionmaker.__repr__.<locals>.<genexpr>)Ú __class__r r¥ rà r r= rÈ r r r Ú__repr__Y s
|
ýzsessionmaker.__repr__).).)N) r r r r r r rÇ rw rV r ra rc r r r r ry w s6
|
^ þù þú þù 3 r r c C s t ¡ D ] } | ¡ qdS )aO Close 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 rc rW )rs r r r r{ a s r¨ r© c C sN t | ¡}t|}|r"| |g¡ |j ¡ |jr6|`|jr@|`|jrJ|`dS )ao Alter 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" (see :ref:`orm_queryguide_column_deferral`) 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) r rÙ r r< Zexpired_attributesrL Z callablesr@ r )r r rG r r r r| s s /
|
|
c C sX t | ¡}|js|jr t d¡|j |¡|_|jr8|`| |j
|
¡ | |j
|
|j ¡ dS )a Make 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`
|
|
z Given object must be transientN) r rÙ rî r@ rÕ rÖ r rõ r r+ rÐ rä Zunloaded_expirable)r r r r r r} ´ s
|
|
c
|
C sL zt | ¡}W n0 tjk
|
r> } zt | ¡|W 5 d}~X Y n
|
X t|S dS )z¾Return the :class:`.Session` to which the given instance belongs.
|
|
This is essentially the same as the :attr:`.InstanceState.session`
|
accessor. See that attribute for details.
|
|
N)r rÙ r rÚ rÛ r )r r r» r r r r~ Û s
|
)²r Ú
|
__future__r rX Úenumr rÓ ro Útypingr r r r r r r
|
r r r r r r r r r r r r6 Ú r r r r r r r r r rJ Ú_typingr! r" r# r$ r& Úbaser' r( r) r* r+ r, r- r. r/ r0 r1 r2 r3 r4 Z state_changesr5 r6 r7 Z
|
unitofworkr8 r: rÕ r; r< r= r> Z engine.utilr? Úeventr@ rA Z
|
inspectionrB rC rD rE rF rG rH rI Zsql.baserJ Z
|
sql.schemarK Zsql.selectablerL rM rN Z util.typingrO rP rQ rR rS rT Z
|
interfacesrU rV r rW Z path_registryrX rY rZ r[ r\ Z engine.baser] r^ Zengine.interfacesr_ r` ra Z engine.resultrb rc Z sql._typingrd re rf rg rh ri rj rk rl rm rn Z_TCCAro rp Z sql.elementsrq Z sql.rolesrr rs rt ru Ú__all__ÚWeakValueDictionaryr r r r! r¿ Z_EntityBindKeyr¸ rN r r r r r¬ Útupler° r± r² r³ r´ Z MemoizedSlotsrz r rx rw r ry r{ r| r} r~ Úcounterr r r r r Ú<module> sz ø þ
|
ÿ2 w D > kA'
|
