Update database docs.

This commit is contained in:
Todd Willey
2010-10-29 15:30:39 -04:00
parent 3ec095bed6
commit 489ddea166
2 changed files with 16 additions and 6 deletions

View File

@@ -18,12 +18,6 @@
Database Programming Guide
==========================
::
TODO(todd): document register_models (where should it be called from?)
document any relevant test cases
document flags
The :mod:`api` Module
---------------------
@@ -59,3 +53,9 @@ The :mod:`sqlalchemy.session` Module
:members:
:undoc-members:
:show-inheritance:
Tests
-----
Tests are lacking for the db api layer and for the sqlalchemy driver.
Failures in the drivers would be dectected in other test cases, though.

View File

@@ -17,6 +17,16 @@
# under the License.
"""
Defines interface for DB access.
The underlying driver is loaded as a :class:`LazyPluggable`.
**Related Flags**
:db_backend: string to lookup in the list of LazyPluggable backends.
`sqlalchemy` is the only supported backend right now.
:sql_connection: string specifying the sqlalchemy connection to use, like:
`sqlite:///var/lib/nova/nova.sqlite`.
"""
from nova import exception