Caution the admins about deleting the users' media though.

[mediagoblin.git] / mediagoblin / db / __init__.py

diff --git a/mediagoblin/db/__init__.py b/mediagoblin/db/__init__.py
index c129cbf867f69dae978186056728b4a8c123a7df..776025ca37c8143df389d6c66031dc7c9978c040 100644 (file)
--- a/mediagoblin/db/__init__.py
+++ b/mediagoblin/db/__init__.py
@@ -13,3 +13,49 @@
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Database Abstraction/Wrapper Layer
+==================================
+
+  **NOTE from Chris Webber:** I asked Elrond to explain why he put
+  ASCENDING and DESCENDING in db/util.py when we could just import from
+  pymongo.  Read beow for why, but note that nobody is actually doing
+  this and there's no proof that we'll ever support more than
+  MongoDB... it would be a huge amount of work to do so.
+  
+  If you really want to prove that possible, jump on IRC and talk to
+  us about making such a branch.  In the meanwhile, it doesn't hurt to
+  have things as they are... if it ever makes it hard for us to
+  actually do things, we might revisit or remove this.  But for more
+  information, read below.
+
+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
+
+"""