mirror of
https://github.com/sqlalchemy/sqlalchemy.git
synced 2026-05-30 20:44:45 -04:00
Mike Bayer
77 lines
1.7 KiB
ReStructuredText
77 lines
1.7 KiB
ReStructuredText
.. module:: sqlalchemy.orm.session
|
|
|
|
Session API
|
|
============
|
|
|
|
Session and sessionmaker()
|
|
---------------------------
|
|
|
|
.. autoclass:: sessionmaker
|
|
:members:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: sqlalchemy.orm.session.Session
|
|
:members:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: sqlalchemy.orm.session.SessionTransaction
|
|
:members:
|
|
|
|
Session Utilites
|
|
----------------
|
|
|
|
.. autofunction:: make_transient
|
|
|
|
.. autofunction:: make_transient_to_detached
|
|
|
|
.. autofunction:: object_session
|
|
|
|
.. autofunction:: sqlalchemy.orm.util.was_deleted
|
|
|
|
Attribute and State Management Utilities
|
|
-----------------------------------------
|
|
|
|
These functions are provided by the SQLAlchemy attribute
|
|
instrumentation API to provide a detailed interface for dealing
|
|
with instances, attribute values, and history. Some of them
|
|
are useful when constructing event listener functions, such as
|
|
those described in :doc:`/orm/events`.
|
|
|
|
.. currentmodule:: sqlalchemy.orm.util
|
|
|
|
.. autofunction:: object_state
|
|
|
|
.. currentmodule:: sqlalchemy.orm.attributes
|
|
|
|
.. autofunction:: del_attribute
|
|
|
|
.. autofunction:: get_attribute
|
|
|
|
.. autofunction:: get_history
|
|
|
|
.. autofunction:: init_collection
|
|
|
|
.. autofunction:: flag_modified
|
|
|
|
.. function:: instance_state
|
|
|
|
Return the :class:`.InstanceState` for a given
|
|
mapped object.
|
|
|
|
This function is the internal version
|
|
of :func:`.object_state`. The
|
|
:func:`.object_state` and/or the
|
|
:func:`.inspect` function is preferred here
|
|
as they each emit an informative exception
|
|
if the given object is not mapped.
|
|
|
|
.. autofunction:: sqlalchemy.orm.instrumentation.is_instrumented
|
|
|
|
.. autofunction:: set_attribute
|
|
|
|
.. autofunction:: set_committed_value
|
|
|
|
.. autoclass:: History
|
|
:members:
|
|
|