Add a query() classmethod to the Document class.

cmlenz · cmlenz · commit 8c173f4b03bc · 2008-01-08T13:04:40.000Z
--HG--
extra : convert_revision : svn%3A7a298fb0-333a-0410-83e7-658617cd9cf3/trunk%4057
diff --git a/couchdb/schema.py b/couchdb/schema.py
@@ -194,17 +194,40 @@ def rev(self):
     rev = property(rev)
 
     def load(cls, db, id):
+        """Load a specific document from the given database."""
         return cls.wrap(db.get(id))
     load = classmethod(load)
 
     def store(self, db):
+        """Store the document in the given database."""
         if getattr(self._data, 'id', None) is None:
             docid = db.create(self._data)
             self._data = db.get(docid)
         else:
             db[self._data.id] = self._data
         return self
 
+    def query(cls, db, code, content_type='text/javascript', eager=False,
+              **options):
+        """Execute a CouchDB temporary view and map the result values back to
+        objects of this schema.
+        
+        Note that by default, any properties of the document that are not
+        included in the values of the view will be treated as if they were
+        missing from the document. If you'd rather want to load the full
+        document for every row, set the `eager` option to `True`, but note that
+        this will initiate a new HTTP request for every document.
+        """
+        def _wrapper(row):
+            if eager:
+                return cls.load(db, row.id)
+            data = row.value
+            data['_id'] = row.id
+            return cls.wrap(data)
+        return db.query(code, content_type=content_type, wrapper=_wrapper,
+                        **options)
+    query = classmethod(query)
+
     def view(cls, db, viewname, eager=False, **options):
         """Execute a CouchDB named view and map the result values back to
         objects of this schema.
