From 3f9d93407be1f719532ba2d1740ae38a6578449a Mon Sep 17 00:00:00 2001 From: Elrond Date: Thu, 30 Jun 2011 23:26:02 +0200 Subject: [PATCH] Document the db submodule a bit Document the ideas behind the db submodule. And document what that actually means. --- mediagoblin/db/__init__.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/mediagoblin/db/__init__.py b/mediagoblin/db/__init__.py index c129cbf8..f0116083 100644 --- a/mediagoblin/db/__init__.py +++ b/mediagoblin/db/__init__.py @@ -13,3 +13,37 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . + +""" +Database Abstraction/Wrapper Layer +================================== + +This submodule is for most of the db specific stuff. + +There are two main ideas here: + +1. Open up a small possibility to replace mongo by another + db. This means, that all direct mongo accesses should + happen in the db submodule. While all the rest uses an + API defined by this submodule. + + Currently this API happens to be basicly mongo. + Which means, that the abstraction/wrapper layer is + extremely thin. + +2. Give the rest of the app a simple and easy way to get most of + their db needs. Which often means some simple import + from db.util. + +What does that mean? + +* Never import mongo directly outside of this submodule. + +* Inside this submodule you can do whatever is needed. The + API border is exactly at the submodule layer. Nowhere + else. + +* helper functions can be moved in here. They become part + of the db.* API + +""" -- 2.25.1