openstack/placement
Code Issues Proposed changes

Added some documentation to db.api module docstring.

Browse Source 
See https://lists.launchpad.net/openstack/msg05222.html for info about return values of db layer.

Change-Id: Id7cc7c783d40a9f81ca0e592691635ee15563e0b
This commit is contained in:
Lorin Hochstein 2011-11-02 11:34:28 -04:00
parent 7400fb3158
commit 00016e3ee6
1 changed files with 9 additions and 0 deletions

9
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.