diff options
| author | Todd Willey <todd@ansolabs.com> | 2010-10-29 15:30:39 -0400 |
|---|---|---|
| committer | Todd Willey <todd@ansolabs.com> | 2010-10-29 15:30:39 -0400 |
| commit | 489ddea1668c742f62acd6fd3e9af78f2f782912 (patch) | |
| tree | 4ec41a99807277bd952ced847435f31123917abd | |
| parent | 3ec095bed60490c844067c8d58ed43dbedee5f0a (diff) | |
Update database docs.
| -rw-r--r-- | doc/source/database.rst | 12 | ||||
| -rw-r--r-- | nova/db/api.py | 10 |
2 files changed, 16 insertions, 6 deletions
diff --git a/doc/source/database.rst b/doc/source/database.rst index 67f940fe1..b58ea147d 100644 --- a/doc/source/database.rst +++ b/doc/source/database.rst @@ -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. diff --git a/nova/db/api.py b/nova/db/api.py index 7cce591ad..659bfd6b8 100644 --- a/nova/db/api.py +++ b/nova/db/api.py @@ -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 |