From 39516876fab278b84ebf133012c2c42d91d80033 Mon Sep 17 00:00:00 2001
From: Salman Haq <salman.haq@neustar.biz>
Date: Mon, 25 Jun 2012 15:08:39 -0400
Subject: [PATCH 1/2] [#162] refactor couchdb backend.

---
 src/backend/couchdb.js | 590 ++++++++++++++++++++++-------------------
 1 file changed, 311 insertions(+), 279 deletions(-)

diff --git a/src/backend/couchdb.js b/src/backend/couchdb.js
index f25e3acc..46540d8e 100644
--- a/src/backend/couchdb.js
+++ b/src/backend/couchdb.js
@@ -3,6 +3,8 @@ this.recline.Backend = this.recline.Backend || {};
 this.recline.Backend.CouchDB = this.recline.Backend.CouchDB || {};
 
 (function($, my) {
+  my.__type__ = 'couchdb';
+
   // ## CouchDB Wrapper
   //
   // Connecting to [CouchDB] (http://www.couchdb.apache.org/) endpoints.
@@ -32,7 +34,7 @@ this.recline.Backend.CouchDB = this.recline.Backend.CouchDB || {};
           }
         };
       }
-      var data = _.extend(extras, data);
+      data = _.extend(extras, data);
       return $.ajax(data);
     };
 
@@ -150,314 +152,344 @@ this.recline.Backend.CouchDB = this.recline.Backend.CouchDB || {};
   //
   // Usage:
   //
-  // var backend = new recline.Backend.CouchDB({
+  // var backend = new recline.Backend.CouchDB();
+  // var dataset = new recline.Model.Dataset({
   //     db_url: '/couchdb/mydb',
   //     view_url: '/couchdb/mydb/_design/design1/_views/view1',
   //     query_options: {
   //          'key': 'some_document_key'
   //     }
   // });
+  // backend.fetch(dataset.toJSON());
+  // backend.query(query, dataset.toJSON()).done(function () { ... });
   //
-  // If these options are not passed to the constructor, the model
-  // object is checked for the presence of these arguments.
-  //
-  // Additionally, the Dataset instance may define two methods:
+  // Additionally, the Dataset instance may define three methods:
   //    function record_update (record, document) { ... }
   //    function record_delete (record, document) { ... }
+  //    function record_create (record, document) { ... }
   // Where `record` is the JSON representation of the Record/Document instance
   // and `document` is the JSON document stored in couchdb.
   // When _all_docs view is used (default), a record is the same as a document
   // so these methods need not be defined.
   // They are most useful when using a custom view that performs a map-reduce
   // operation on each document to yield a record. Hence, when the record is 
-  // updated or deleted, an inverse operation must be performed on the original
+  // created, updated or deleted, an inverse operation must be performed on the original
   // document.
   //
   // @param {string} url of couchdb database.
   // @param {string} (optional) url of couchdb view. default:`db_url`/_all_docs
   // @param {Object} (optional) query options accepted by couchdb views.
-  // @param {string} (optional) url of Elastic Search engine.
   //
-  my.Backbone = function(options) {
-    var self           = this;
-    this.__type__      ='couchdb';
-    this.db_url        = options['db_url'] || '';
-    this.view_url      = options['view_url'] || this.db_url + '/_all_docs';
-    this.query_options = options['query_options'] || {};
 
-    // ### sync
-    //
-    // Backbone sync implementation for this backend.
-    //
-    this.sync = function (method, model, options) {
-      var dataset = null
-      if (model.__type__ == 'Dataset')
-        dataset = model;
-      else 
-        dataset = model.dataset;
+  my.couchOptions = {};
 
-      var db_url        = dataset.get('db_url') || self.db_url;
-      var view_url      = dataset.get('view_url') || self.view_url;
-      var query_options = dataset.get('query_options') || self.query_options;
+  // ### fetch
+  // @param {object} dataset json object with the db_url, view_url, and query_options args.
+  // @return promise object that resolves to the document mapping.
+  my.fetch = function (dataset) {
+    var db_url    = dataset.db_url;
+    var view_url  = dataset.view_url;
+    var cdb       = new my.CouchDBWrapper(db_url, view_url);
+    var dfd       = $.Deferred();
 
-      var cdb = new my.CouchDBWrapper(db_url, view_url);
-
-      if (method === "read") {
-        if (model.__type__ == 'Dataset') {
-          var dfd = $.Deferred();
-
-          // if 'doc' attribute is present, return schema of that
-          // else return schema of 'value' attribute which contains
-          // the map-reduce document.
-          cdb.mapping().done(function(result) {
-            var row = result.rows[0];
-            var keys = [];
-            if (view_url.search("_all_docs") !== -1) {
-              keys = _.keys(row['doc']);
-              keys = _.filter(keys, function (k) { return k.charAt(0) !== '_' });
-            }
-            else {
-              keys = _.keys(row['value']);
-            }
-
-            var fieldData = _.map(keys, function(k) {
-              return { 'id' : k };
-            });
-            model.fields.reset(fieldData);
-            
-            dfd.resolve(model);
-          })
-          .fail(function(arguments) {
-            dfd.reject(arguments);
-          });
-          return dfd.promise();
-        } else if (model.__type__ == 'Record' || model.__type__ == 'Document') {
-          if (view_url.search("_all_docs") !== -1) {
-            return cdb.get(model.get('_id'));
-          }
-          else {
-            var dfd = $.Deferred();
-            // decompose _id
-            var id  = model.get('_id').split('__')[0];
-            var key = model.get('_id').split('__')[1];
-            var jqxhr = cdb.query(model.dataset.get('query_options'));
-
-            jqxhr.done(function(records) {
-              var doc = {};
-              var rec = _.filter(records, function (record) {
-                record['id'] == id && record['key'] == key;
-              });
-              doc = rec[0]; // XXX check len first
-              doc['id'] = doc['_id'] = model.get('_id');
-              dfd.resolve(doc);
-            }).fail(function(args) {
-              dfd.reject(args);
-            });
-            return dfd.promise();
-          }
-        }       
-      } else if (method === 'update') {
-        if (model.__type__ == 'Record' || model.__type__ == 'Document') {
-          var dfd = $.Deferred();
-          var _id = null;
-          var jqxhr;
-          var new_doc = model.toJSON();
-          // couchdb uses _id to identify documents, Backbone models use id.
-          // we should remove it before sending it to the server.
-          delete new_doc['id']; 
-          if (view_url.search('_all_docs') !== -1) {
-            _id = model.get('_id');
-            jqxhr = cdb.get(_id);
-          }
-          else {
-            _id = model.get('_id').split('__')[0];
-            jqxhr = cdb.get(_id);
-          }
-
-          jqxhr.done(function(old_doc){
-            if (model.dataset.record_update)
-              new_doc = model.dataset.record_update(new_doc, old_doc);
-            new_doc = _.extend(old_doc, new_doc);
-            new_doc['_id'] = _id;
-            // XXX upsert can fail during a bulk column transform due to revision conflict.
-            // the correct way to handle bulk column transforms is to use
-            // a queue which is processed by a web worker.
-            dfd.resolve(cdb.upsert(new_doc));            
-          }).fail(function(args){
-            dfd.reject(args);
-          });
-
-          return dfd.promise();
-        }
-      } else if (method === 'delete') {
-        if (model.__type__ == 'Record' || model.__type__ == 'Document') {
-          if (view_url.search('_all_docs') !== -1) 
-            return cdb.delete(model.get('_id'));
-          else {
-            var dfd = $.Deferred();
-            var _id = model.get('_id').split('__')[0];
-            var new_doc = null;
-            var jqxhr = cdb.get(_id);
-
-            jqxhr.done(function(old_doc){
-              if (model.dataset.record_delete)
-                new_doc = model.dataset.record_delete(model.toJSON(), old_doc);
-              if (_.isNull(new_doc))
-                dfd.resolve(cdb.delete(_id)); // XXX is this the right thing to do?
-              else {
-                // couchdb uses _id to identify documents, Backbone models use id.
-                // we should remove it before sending it to the server.
-                new_doc['_id'] = _id;
-                delete new_doc['id'];
-                dfd.resolve(cdb.upsert(new_doc)); 
-              }
-            }).fail(function(args){
-              dfd.reject(args);
-            });
-            return dfd.promise();
-          }
-        }
+    // if 'doc' attribute is present, return schema of that
+    // else return schema of 'value' attribute which contains
+    // the map-reduced document.
+    cdb.mapping().done(function(result) {
+      var row = result.rows[0];
+      var keys = [];
+      if (view_url.search("_all_docs") !== -1) {
+        keys = _.keys(row['doc']);
+        keys = _.filter(keys, function (k) { return k.charAt(0) !== '_' });
       }
-    
-  },
-
-    // ### query
-    //
-    // fetch the data from the couchdb view and filter it.
-    // @param {Object} recline.Dataset instance
-    // @param {Object} recline.Query instance.
-    this.query = function(model, queryObj) {
-      var dfd           = $.Deferred();
-      var db_url        = model.get('db_url') || self.db_url;
-      var view_url      = model.get('view_url') || self.view_url;
-      var query_options = model.get('query_options') || self.query_options;
-
-      var cdb = new my.CouchDBWrapper(db_url, view_url); 
-      var cdb_q = cdb._normalizeQuery(queryObj, query_options);
-
-      cdb.query(queryObj, query_options).done(function(records){
-
-        var query_result = { hits: [], total: 0 };
-        _.each(records.rows, function(record) {
-          var doc = {};
-          if (record.hasOwnProperty('doc')) {
-            doc['_source'] = record['doc'];
-            // couchdb uses _id to identify documents, Backbone models use id.
-            // we add this fix so backbone.Model works correctly.
-            doc['_source']['id'] = doc['_source']['_id'];
-          }
-          else {
-            doc['_source'] = record['value'];
-            // using dunder to create compound id. need something more robust.
-            doc['_source']['_id'] = record['id'] + '__' + record['key']; 
-            // couchdb uses _id to identify documents, Backbone models use id.
-            // we add this fix so backbone.Model works correctly.
-            doc['_source']['id'] = doc['_source']['_id'];
-          }
-          query_result.total += 1;
-          query_result.hits.push(doc);
-        });
-
-        // the following block is borrowed verbatim from recline.backend.Memory
-        // search (with filtering, faceting, and sorting) should be factored
-        // out into a separate library.
-        query_result.hits = self._applyFilters(query_result.hits, queryObj);
-        query_result.hits = self._applyFreeTextQuery(query_result.hits, queryObj);
-        // not complete sorting!
-        _.each(queryObj.sort, function(sortObj) {
-          var fieldName = _.keys(sortObj)[0];
-          query_result.hits = _.sortBy(query_result.hits, function(doc) {
-            var _out = doc[fieldName];
-            return (sortObj[fieldName].order == 'asc') ? _out : -1*_out;
-          });
-        });
-        query_result.total  = query_result.hits.length;
-        query_result.facets = self.computeFacets(query_result.hits, queryObj);
-        query_result.hits = query_result.hits.slice(cdb_q.skip, cdb_q.skip + cdb_q.limit+1);
-        dfd.resolve(query_result);
-
-      });
-      
-      return dfd.promise();
-    },
-
-    // in place filtering
-    _applyFilters: function(results, queryObj) {
-      _.each(queryObj.filters, function(filter) {
-        results = _.filter(results, function(doc) {
-          var fieldId = _.keys(filter.term)[0];
-          return (doc['_source'][fieldId] == filter.term[fieldId]);
-        });
-      });
-      return results;
-    },
-
-    // we OR across fields but AND across terms in query string
-    _applyFreeTextQuery: function(results, queryObj) {
-      if (queryObj.q) {
-        var terms = queryObj.q.split(' ');
-        results = _.filter(results, function(rawdoc) {
-          rawdoc = rawdoc['_source'];
-          var matches = true;
-          _.each(terms, function(term) {
-            var foundmatch = false;
-            //_.each(self.fields, function(field) {
-              _.each(_.keys(rawdoc), function(field) {
-              var value = rawdoc[field];
-              if (value !== null) { value = value.toString(); }
-              // TODO regexes?
-              foundmatch = foundmatch || (value === term);
-              // TODO: early out (once we are true should break to spare unnecessary testing)
-              // if (foundmatch) return true;
-            });
-            matches = matches && foundmatch;
-            // TODO: early out (once false should break to spare unnecessary testing)
-            // if (!matches) return false;
-          });
-          return matches;
-        });
+      else {
+        keys = _.keys(row['value']);
       }
-      return results;
-    },
 
-    computeFacets: function(records, queryObj) {
-      var facetResults = {};
-      if (!queryObj.facets) {
-        return facetResults;
+      var fieldData = _.map(keys, function(k) {
+        return { 'id' : k };
+      });     
+      dfd.resolve({
+        fields: fieldData
+      });
+    })
+    .fail(function(arguments) {
+      dfd.reject(arguments);
+    });
+    return dfd.promise();
+  };
+
+// ### save
+// 
+// Iterate through all the changes and save them to the server.
+// N.B. This method is asynchronous and attempts to do multiple
+// operation concurrently. This can be problematic when more than
+// one operation is requested on the same document (as in the case
+// of bulk column transforms).
+//
+// @param {object} lists of create, update, delete.
+// @param {object} dataset json object.
+//
+//
+my.save = function (changes, dataset) {
+  var dfd       = $.Deferred();
+  var total     = changes.creates.length + changes.updates.length + changes.deletes.length;  
+  var results   = {'done': [], 'fail': [] };
+
+  var decr_cb = function () { total -= 1; }
+  var resolve_cb = function () { if (total == 0) dfd.resolve(results); }
+
+  for (var i in changes.creates) {
+    var new_doc = changes.creates[i];
+    var succ_cb = function (msg) {results.done.push({'op': 'create', 'record': new_doc, 'reason': ''}); }
+    var fail_cb = function (msg) {results.fail.push({'op': 'create', 'record': new_doc, 'reason': msg}); }
+
+    my._create_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+  }
+
+  for (var i in changes.updates) {
+    var new_doc = changes.updates[i];
+    var succ_cb = function (msg) {results.done.push({'op': 'update', 'record': new_doc, 'reason': ''}); }
+    var fail_cb = function (msg) {results.fail.push({'op': 'update', 'record': new_doc, 'reason': msg}); }
+
+    my._update_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+  }
+
+  for (var i in changes.deletes) {
+    var old_doc = changes.deletes[i];
+    var succ_cb = function (msg) {results.done.push({'op': 'delete', 'record': old_doc, 'reason': ''}); }
+    var fail_cb = function (msg) {results.fail.push({'op': 'delete', 'record': old_doc, 'reason': msg}); }
+
+    my._delete_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+  }
+
+  return dfd.promise();
+};
+
+
+// ### query
+//
+// fetch the data from the couchdb view and filter it.
+// @param {Object} recline.Dataset instance
+// @param {Object} recline.Query instance.
+my.query = function(queryObj, dataset) {
+  var dfd           = $.Deferred();
+  var db_url        = dataset.db_url;
+  var view_url      = dataset.view_url;
+  var query_options = dataset.query_options;
+
+  var cdb = new my.CouchDBWrapper(db_url, view_url); 
+  var cdb_q = cdb._normalizeQuery(queryObj, query_options);
+
+  cdb.query(queryObj, query_options).done(function(records){
+
+    var query_result = { hits: [], total: 0 };
+    _.each(records.rows, function(record) {
+      var doc = {};
+      if (record.hasOwnProperty('doc')) {
+        doc = record['doc'];
+        // couchdb uses _id to identify documents, Backbone models use id.
+        // we add this fix so backbone.Model works correctly.
+        doc['id'] = doc['_id'];
       }
-      _.each(queryObj.facets, function(query, facetId) {
-        // TODO: remove dependency on recline.Model
-        facetResults[facetId] = new recline.Model.Facet({id: facetId}).toJSON();
-        facetResults[facetId].termsall = {};
+      else {
+        doc = record['value'];
+        // using dunder to create compound id. need something more robust.
+        // couchdb uses _id to identify documents, Backbone models use id.
+        // we add this fix so backbone.Model works correctly.
+        doc['_id'] = doc['id'] = record['id'] + '__' + record['key']; 
+      }
+      query_result.total += 1;
+      query_result.hits.push(doc);
+    });
+
+    // the following block is borrowed verbatim from recline.backend.Memory
+    // search (with filtering, faceting, and sorting) should be factored
+    // out into a separate library.
+    query_result.hits = self._applyFilters(query_result.hits, queryObj);
+    query_result.hits = self._applyFreeTextQuery(query_result.hits, queryObj);
+    // not complete sorting!
+    _.each(queryObj.sort, function(sortObj) {
+      var fieldName = _.keys(sortObj)[0];
+      query_result.hits = _.sortBy(query_result.hits, function(doc) {
+        var _out = doc[fieldName];
+        return (sortObj[fieldName].order == 'asc') ? _out : -1*_out;
       });
-      // faceting
-      _.each(records, function(doc) {
-        _.each(queryObj.facets, function(query, facetId) {
-          var fieldId = query.terms.field;
-          var val = doc['_source'][fieldId];
-          var tmp = facetResults[facetId];
-          if (val) {
-            tmp.termsall[val] = tmp.termsall[val] ? tmp.termsall[val] + 1 : 1;
-          } else {
-            tmp.missing = tmp.missing + 1;
-          }
-        });
-      });
-      _.each(queryObj.facets, function(query, facetId) {
-        var tmp = facetResults[facetId];
-        var terms = _.map(tmp.termsall, function(count, term) {
-          return { term: term, count: count };
-        });
-        tmp.terms = _.sortBy(terms, function(item) {
-          // want descending order
-          return -item.count;
-        });
-        tmp.terms = tmp.terms.slice(0, 10);
-      });
-      return facetResults;
-    },
-     
+    });
+    query_result.total  = query_result.hits.length;
+    query_result.facets = self.computeFacets(query_result.hits, queryObj);
+    query_result.hits = query_result.hits.slice(cdb_q.skip, cdb_q.skip + cdb_q.limit+1);
+    dfd.resolve(query_result);
 
   });
+  
+  return dfd.promise();
+};
+
+// in place filtering
+my._applyFilters = function(results, queryObj) {
+  _.each(queryObj.filters, function(filter) {
+    results = _.filter(results, function(doc) {
+      var fieldId = _.keys(filter.term)[0];
+      return (doc[fieldId] == filter.term[fieldId]);
+    });
+  });
+  return results;
+};
+
+// we OR across fields but AND across terms in query string
+my._applyFreeTextQuery = function(results, queryObj) {
+  if (queryObj.q) {
+    var terms = queryObj.q.split(' ');
+    results = _.filter(results, function(rawdoc) {
+      var matches = true;
+      _.each(terms, function(term) {
+        var foundmatch = false;
+        //_.each(self.fields, function(field) {
+          _.each(_.keys(rawdoc), function(field) {
+          var value = rawdoc[field];
+          if (value !== null) { value = value.toString(); }
+          // TODO regexes?
+          foundmatch = foundmatch || (value === term);
+          // TODO: early out (once we are true should break to spare unnecessary testing)
+          // if (foundmatch) return true;
+        });
+        matches = matches && foundmatch;
+        // TODO: early out (once false should break to spare unnecessary testing)
+        // if (!matches) return false;
+      });
+      return matches;
+    });
+  }
+  return results;
+};
+
+my.computeFacets = function(records, queryObj) {
+  var facetResults = {};
+  if (!queryObj.facets) {
+    return facetResults;
+  }
+  _.each(queryObj.facets, function(query, facetId) {
+    // TODO: remove dependency on recline.Model
+    facetResults[facetId] = new recline.Model.Facet({id: facetId}).toJSON();
+    facetResults[facetId].termsall = {};
+  });
+  // faceting
+  _.each(records, function(doc) {
+    _.each(queryObj.facets, function(query, facetId) {
+      var fieldId = query.terms.field;
+      var val = doc[fieldId];
+      var tmp = facetResults[facetId];
+      if (val) {
+        tmp.termsall[val] = tmp.termsall[val] ? tmp.termsall[val] + 1 : 1;
+      } else {
+        tmp.missing = tmp.missing + 1;
+      }
+    });
+  });
+  _.each(queryObj.facets, function(query, facetId) {
+    var tmp = facetResults[facetId];
+    var terms = _.map(tmp.termsall, function(count, term) {
+      return { term: term, count: count };
+    });
+    tmp.terms = _.sortBy(terms, function(item) {
+      // want descending order
+      return -item.count;
+    });
+    tmp.terms = tmp.terms.slice(0, 10);
+  });
+  return facetResults;
+};
+     
+my._create_document  = function (new_doc, dataset) {
+  var dfd      = $.Deferred();
+  var db_url   = dataset.db_url;
+  var view_url = dataset.view_url;
+  var _id      = new_doc['id'];
+  var cdb      = new my.CouchDBWrapper(db_url, view_url);
+
+  delete new_doc['id']; 
+
+  if (view_url.search('_all_docs') !== -1) {
+    jqxhr = cdb.get(_id);
+  }
+  else {
+    _id = new_doc['_id'].split('__')[0];
+    jqxhr = cdb.get(_id);
+  }
+
+  jqxhr.done(function(old_doc){
+    if (dataset.record_create)
+      new_doc = dataset.record_create(new_doc, old_doc);
+    new_doc = _.extend(old_doc, new_doc);
+    new_doc['_id'] = _id;
+    dfd.resolve(cdb.upsert(new_doc));            
+  }).fail(function(args){
+    dfd.reject(args);
+  });
+
+  return dfd.promise();
+};
+
+my._update_document = function (new_doc, dataset) {
+  var dfd      = $.Deferred();
+  var db_url   = dataset.db_url;
+  var view_url = dataset.view_url;
+  var _id      = new_doc['id'];
+  var cdb      = new my.CouchDBWrapper(db_url, view_url);
+
+  delete new_doc['id']; 
+
+  if (view_url.search('_all_docs') !== -1) {
+    jqxhr = cdb.get(_id);
+  }
+  else {
+    _id = new_doc['_id'].split('__')[0];
+    jqxhr = cdb.get(_id);
+  }
+
+  jqxhr.done(function(old_doc){
+    if (dataset.record_update)
+      new_doc = dataset.record_update(new_doc, old_doc);
+    new_doc = _.extend(old_doc, new_doc);
+    new_doc['_id'] = _id;
+    dfd.resolve(cdb.upsert(new_doc));            
+  }).fail(function(args){
+    dfd.reject(args);
+  });
+
+  return dfd.promise();
+};
+
+my._delete_document = function (del_doc, dataset) {
+  var dfd      = $.Deferred();
+  var db_url   = dataset.db_url;
+  var view_url = dataset.view_url;
+  var _id      = del_doc['id'];
+  var cdb      = new my.CouchDBWrapper(db_url, view_url);
+
+  if (view_url.search('_all_docs') !== -1) 
+    return cdb.delete(_id);
+  else {
+    _id = model.get('_id').split('__')[0];
+    var jqxhr = cdb.get(_id);
+
+    jqxhr.done(function(old_doc){
+      if (dataset.record_delete)
+        old_doc = dataset.record_delete(del_doc, old_doc);
+      if (_.isNull(del_doc))
+        dfd.resolve(cdb.delete(_id)); // XXX is this the right thing to do?
+      else {
+        // couchdb uses _id to identify documents, Backbone models use id.
+        // we should remove it before sending it to the server.
+        old_doc['_id'] = _id;
+        delete old_doc['id'];
+        dfd.resolve(cdb.upsert(old_doc)); 
+      }
+    }).fail(function(args){
+      dfd.reject(args);
+    });
+    return dfd.promise();
+};
 
 }(jQuery, this.recline.Backend.CouchDB));

From fb9d154834775f468d33c6f9ada6e49364c43796 Mon Sep 17 00:00:00 2001
From: Salman Haq <salman.haq@neustar.biz>
Date: Tue, 26 Jun 2012 09:55:46 -0400
Subject: [PATCH 2/2] #162 minor stylistic changes based on feedback.

---
 src/backend/couchdb.js | 34 +++++++++++++++++++---------------
 1 file changed, 19 insertions(+), 15 deletions(-)

diff --git a/src/backend/couchdb.js b/src/backend/couchdb.js
index 46540d8e..3fa930f2 100644
--- a/src/backend/couchdb.js
+++ b/src/backend/couchdb.js
@@ -163,6 +163,11 @@ this.recline.Backend.CouchDB = this.recline.Backend.CouchDB || {};
   // backend.fetch(dataset.toJSON());
   // backend.query(query, dataset.toJSON()).done(function () { ... });
   //
+  // Alternatively:
+  // var dataset = new recline.Model.Dataset({ ... }, 'couchdb');
+  // dataset.fetch();
+  // var results = dataset.query(query_obj);
+  // 
   // Additionally, the Dataset instance may define three methods:
   //    function record_update (record, document) { ... }
   //    function record_delete (record, document) { ... }
@@ -244,7 +249,7 @@ my.save = function (changes, dataset) {
     var succ_cb = function (msg) {results.done.push({'op': 'create', 'record': new_doc, 'reason': ''}); }
     var fail_cb = function (msg) {results.fail.push({'op': 'create', 'record': new_doc, 'reason': msg}); }
 
-    my._create_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+    _createDocument(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
   }
 
   for (var i in changes.updates) {
@@ -252,7 +257,7 @@ my.save = function (changes, dataset) {
     var succ_cb = function (msg) {results.done.push({'op': 'update', 'record': new_doc, 'reason': ''}); }
     var fail_cb = function (msg) {results.fail.push({'op': 'update', 'record': new_doc, 'reason': msg}); }
 
-    my._update_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+    _updateDocument(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
   }
 
   for (var i in changes.deletes) {
@@ -260,7 +265,7 @@ my.save = function (changes, dataset) {
     var succ_cb = function (msg) {results.done.push({'op': 'delete', 'record': old_doc, 'reason': ''}); }
     var fail_cb = function (msg) {results.fail.push({'op': 'delete', 'record': old_doc, 'reason': msg}); }
 
-    my._delete_document(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
+    _deleteDocument(new_doc, dataset).then([decr_cb, succ_cb, resolve_cb], [decr_cb, fail_cb, resolve_cb]);
   }
 
   return dfd.promise();
@@ -306,8 +311,8 @@ my.query = function(queryObj, dataset) {
     // the following block is borrowed verbatim from recline.backend.Memory
     // search (with filtering, faceting, and sorting) should be factored
     // out into a separate library.
-    query_result.hits = self._applyFilters(query_result.hits, queryObj);
-    query_result.hits = self._applyFreeTextQuery(query_result.hits, queryObj);
+    query_result.hits = _applyFilters(query_result.hits, queryObj);
+    query_result.hits = _applyFreeTextQuery(query_result.hits, queryObj);
     // not complete sorting!
     _.each(queryObj.sort, function(sortObj) {
       var fieldName = _.keys(sortObj)[0];
@@ -317,7 +322,7 @@ my.query = function(queryObj, dataset) {
       });
     });
     query_result.total  = query_result.hits.length;
-    query_result.facets = self.computeFacets(query_result.hits, queryObj);
+    query_result.facets = _computeFacets(query_result.hits, queryObj);
     query_result.hits = query_result.hits.slice(cdb_q.skip, cdb_q.skip + cdb_q.limit+1);
     dfd.resolve(query_result);
 
@@ -327,7 +332,7 @@ my.query = function(queryObj, dataset) {
 };
 
 // in place filtering
-my._applyFilters = function(results, queryObj) {
+_applyFilters = function(results, queryObj) {
   _.each(queryObj.filters, function(filter) {
     results = _.filter(results, function(doc) {
       var fieldId = _.keys(filter.term)[0];
@@ -338,15 +343,14 @@ my._applyFilters = function(results, queryObj) {
 };
 
 // we OR across fields but AND across terms in query string
-my._applyFreeTextQuery = function(results, queryObj) {
+_applyFreeTextQuery = function(results, queryObj) {
   if (queryObj.q) {
     var terms = queryObj.q.split(' ');
     results = _.filter(results, function(rawdoc) {
       var matches = true;
       _.each(terms, function(term) {
-        var foundmatch = false;
-        //_.each(self.fields, function(field) {
-          _.each(_.keys(rawdoc), function(field) {
+        var foundmatch = false;      
+        _.each(_.keys(rawdoc), function(field) {
           var value = rawdoc[field];
           if (value !== null) { value = value.toString(); }
           // TODO regexes?
@@ -364,7 +368,7 @@ my._applyFreeTextQuery = function(results, queryObj) {
   return results;
 };
 
-my.computeFacets = function(records, queryObj) {
+_computeFacets = function(records, queryObj) {
   var facetResults = {};
   if (!queryObj.facets) {
     return facetResults;
@@ -401,7 +405,7 @@ my.computeFacets = function(records, queryObj) {
   return facetResults;
 };
      
-my._create_document  = function (new_doc, dataset) {
+_createDocument  = function (new_doc, dataset) {
   var dfd      = $.Deferred();
   var db_url   = dataset.db_url;
   var view_url = dataset.view_url;
@@ -431,7 +435,7 @@ my._create_document  = function (new_doc, dataset) {
   return dfd.promise();
 };
 
-my._update_document = function (new_doc, dataset) {
+_updateDocument = function (new_doc, dataset) {
   var dfd      = $.Deferred();
   var db_url   = dataset.db_url;
   var view_url = dataset.view_url;
@@ -461,7 +465,7 @@ my._update_document = function (new_doc, dataset) {
   return dfd.promise();
 };
 
-my._delete_document = function (del_doc, dataset) {
+_deleteDocument = function (del_doc, dataset) {
   var dfd      = $.Deferred();
   var db_url   = dataset.db_url;
   var view_url = dataset.view_url;