Classe « ORMExecuteState »

Informations générales

Héritage

builtins.object
    MemoizedSlots
        ORMExecuteState

Définition

class ORMExecuteState(MemoizedSlots):

help(ORMExecuteState)

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`

Constructeur(s)

Signature du constructeur	Description
__init__(self, session: 'Session', statement: 'Executable', parameters: 'Optional[_CoreAnyExecuteParams]', execution_options: '_ExecuteOptions', bind_arguments: '_BindArguments', compile_state_cls: 'Optional[Type[ORMCompileState]]', events_todo: 'List[_InstanceLevelDispatch[Session]]')	Construct a new :class:`_orm.ORMExecuteState`. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
bind_arguments	<member 'bind_arguments' of 'ORMExecuteState' objects>
execution_options	<member 'execution_options' of 'ORMExecuteState' objects>
identity_token	<member 'identity_token' of 'ORMExecuteState' objects>
local_execution_options	<member 'local_execution_options' of 'ORMExecuteState' objects>
parameters	<member 'parameters' of 'ORMExecuteState' objects>
session	<member 'session' of 'ORMExecuteState' objects>
statement	<member 'statement' of 'ORMExecuteState' objects>

Liste des propriétés

Nom de la propriété	Description
all_mappers	Return a sequence of all :class:`_orm.Mapper` objects that are _{[extrait de all_mappers.__doc__]}
bind_mapper	Return the :class:`_orm.Mapper` that is the primary "bind" mapper. _{[extrait de bind_mapper.__doc__]}
is_column_load	Return True if the operation is refreshing column-oriented _{[extrait de is_column_load.__doc__]}
is_delete	return True if this is a DELETE operation. _{[extrait de is_delete.__doc__]}
is_executemany	return True if the parameters are a multi-element list of _{[extrait de is_executemany.__doc__]}
is_from_statement	return True if this operation is a _{[extrait de is_from_statement.__doc__]}
is_insert	return True if this is an INSERT operation. _{[extrait de is_insert.__doc__]}
is_orm_statement	return True if the operation is an ORM statement. _{[extrait de is_orm_statement.__doc__]}
is_relationship_load	Return True if this load is loading objects on behalf of a _{[extrait de is_relationship_load.__doc__]}
is_select	return True if this is a SELECT operation. _{[extrait de is_select.__doc__]}
is_update	return True if this is an UPDATE operation. _{[extrait de is_update.__doc__]}
lazy_loaded_from	An :class:`.InstanceState` that is using this statement execution _{[extrait de lazy_loaded_from.__doc__]}
load_options	Return the load_options that will be used for this execution. _{[extrait de load_options.__doc__]}
loader_strategy_path	Return the :class:`.PathRegistry` for the current load path. _{[extrait de loader_strategy_path.__doc__]}
update_delete_options	Return the update_delete_options that will be used for this _{[extrait de update_delete_options.__doc__]}
user_defined_options	The sequence of :class:`.UserDefinedOptions` that have been _{[extrait de user_defined_options.__doc__]}

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
invoke_statement(self, statement: 'Optional[Executable]' = None, params: 'Optional[_CoreAnyExecuteParams]' = None, execution_options: 'Optional[OrmExecuteOptionsParameter]' = None, bind_arguments: 'Optional[_BindArguments]' = None) -> 'Result[Any]'	Execute the statement represented by this _{[extrait de invoke_statement.__doc__]}
update_execution_options(self, **opts: 'Any') -> 'None'	Update the local execution options with new values. _{[extrait de update_execution_options.__doc__]}