add initial docs
This commit is contained in:
parent
df7fad8edc
commit
69e92c13db
19 changed files with 878 additions and 30 deletions
30
docs/edbob.db.rst
Normal file
30
docs/edbob.db.rst
Normal file
|
@ -0,0 +1,30 @@
|
|||
|
||||
:mod:`edbob.db`
|
||||
===============
|
||||
|
||||
.. automodule:: edbob.db
|
||||
|
||||
.. attribute:: engines
|
||||
|
||||
A dictionary of configured :class:`sqlalchemy.Engine` instances available to
|
||||
the application.
|
||||
|
||||
.. attribute:: engine
|
||||
|
||||
A reference to the default :class:`sqlalchemy.Engine` instance for the
|
||||
application.
|
||||
|
||||
.. attribute:: metadata
|
||||
|
||||
A reference to the global :class:`sqlalchemy.MetaData` instance for the
|
||||
application.
|
||||
|
||||
.. class:: Session
|
||||
|
||||
A :class:`sqlalchemy.orm.Session` class for use within the application.
|
||||
|
||||
.. autofunction:: get_setting
|
||||
|
||||
.. autofunction:: save_setting
|
||||
|
||||
.. autofunction:: needs_session
|
Loading…
Add table
Add a link
Reference in a new issue