diff options
| author | Lorin Hochstein <lorin@isi.edu> | 2011-11-02 11:34:28 -0400 |
|---|---|---|
| committer | Lorin Hochstein <lorin@isi.edu> | 2011-11-02 11:34:28 -0400 |
| commit | 923c3c520609b70e234731b401762bda2623e951 (patch) | |
| tree | 9c4aadf3d4d3ed50ea5e4ac983e43cd0e17e1ffb | |
| parent | d3e0cfcc7f7bc24b4bd551f5b5c0c952f2fd2f3f (diff) | |
| download | nova-923c3c520609b70e234731b401762bda2623e951.tar.gz nova-923c3c520609b70e234731b401762bda2623e951.tar.xz nova-923c3c520609b70e234731b401762bda2623e951.zip | |
Added some documentation to db.api module docstring.
See https://lists.launchpad.net/openstack/msg05222.html for info about return values of db layer.
Change-Id: Id7cc7c783d40a9f81ca0e592691635ee15563e0b
| -rw-r--r-- | nova/db/api.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/nova/db/api.py b/nova/db/api.py index 7af81a1a2..a7668e82a 100644 --- a/nova/db/api.py +++ b/nova/db/api.py @@ -20,6 +20,15 @@ The underlying driver is loaded as a :class:`LazyPluggable`. +Functions in this module are imported into the nova.db namespace. Call these +functions from nova.db namespace, not the nova.db.api namespace. + +All functions in this module return objects that implement a dictionary-like +interface. Currently, many of these objects are sqlalchemy objects that +implement a dictionary interface. However, a future goal is to have all of +these objects be simple dictionaries. + + **Related Flags** :db_backend: string to lookup in the list of LazyPluggable backends. |