X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=mediagoblin%2Fdb%2F__init__.py;h=719b56e7c231319f077d06ed4a036bc571d41fc8;hb=23002ee77f742f3b00fbee64def0dea5de0f5e51;hp=27ca4b06547fb0fd8cdca37e63b4eb38e49bda62;hpb=e02b7b6b3bd6b20c65aeb2ca5fd1e0030b631b88;p=mediagoblin.git diff --git a/mediagoblin/db/__init__.py b/mediagoblin/db/__init__.py index 27ca4b06..719b56e7 100644 --- a/mediagoblin/db/__init__.py +++ b/mediagoblin/db/__init__.py @@ -14,36 +14,3 @@ # 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 - -"""