summaryrefslogtreecommitdiff
path: root/doc/build/orm/session_api.rst
diff options
context:
space:
mode:
authorSławek Ehlert <slafs@op.pl>2015-01-27 22:04:38 +0100
committerSławek Ehlert <slafs@op.pl>2015-01-27 22:04:38 +0100
commit57b2bd5dcba6140b511c898c0f682234f13d5c51 (patch)
treea0899b2a35d27e177001b163054c3c9a8f7f1c06 /doc/build/orm/session_api.rst
parent6a1f16d09958e549502a0991890d64964c71b357 (diff)
parent8aaa8dd6bdfb85fa481efa3115b9080d935d344c (diff)
downloadsqlalchemy-pr/152.tar.gz
Merge branch 'master' into oracle-servicename-optionpr/152
Diffstat (limited to 'doc/build/orm/session_api.rst')
-rw-r--r--doc/build/orm/session_api.rst76
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/build/orm/session_api.rst b/doc/build/orm/session_api.rst
new file mode 100644
index 000000000..3754ac80b
--- /dev/null
+++ b/doc/build/orm/session_api.rst
@@ -0,0 +1,76 @@
+.. 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:
+