feat: allow primary key in update()

README.md

@@ -192,7 +192,7 @@ db.tests.insert({
 }).then(test => {...});
 ```
 
-Last bit of housekeeping: `alice` still doesn't have a role, however, and we may have added more users without roles as well. Let's perform a bulk update to ensure that we're giving people the right access levels:
+Last bit of housekeeping: `alice` still doesn't have a role, and we may have added more users without roles as well. Let's perform a bulk update to ensure that we're giving people the right access levels:
 
 ```javascript
 db.auth.users.update({

docs/persistence.md

@@ -109,7 +109,7 @@ db.tests.insert({
 
 ## update
 
-`update` alters existing records in a table, given a criteria object and a map of column names to the new values. It returns a promise for an array containing the updated records.
+`update` alters existing records in a table, given a criteria object (or unary primary key) and a map of column names to the new values. It returns a promise for an array containing the updated record(s) if passed a criteria object, or a promise for an object if passed a primary key.
 
 ```javascript
 db.tests.update({

lib/statement/update.js

@@ -39,9 +39,14 @@ const Update = function (source, changes, criteria = {}, options = {}) {
   this.stream = options.stream;
 
   if (source.isPkSearch(criteria, options)) {
-    // update doesn't support primitive searches, but this ensures that
-    // document pk searches use the standard generator
-    this.where = where(criteria, this.params.length);
+    if (_.isPlainObject(criteria)) {
+      // id:val search
+      this.where = where(criteria, this.params.length);
+    } else {
+      // primitive unary pk search
+      this.where = where(_.fromPairs([[source.pk[0], criteria]]), this.params.length);
+      this.single = true;
+    }
   } else {
     this.where = where(criteria, this.params.length, this.generator);
   }

lib/table.js

@@ -89,9 +89,9 @@ Table.prototype.insert = function (data, options) {
  * criteria object and a map of fields to new values. Multi-row updates are
  * only possible through the latter usage.
  *
- * @param {Object} criteria - A criteria object.
- * @param {Object} changes - If using a criteria object without a primary key,
- * a hash of column names to their new values.
+ * @param {String|Number|Object} criteria - Primary key of the record, or a
+ * criteria object.
+ * @param {Object} changes - A map of columns to their new values.
  * @param {Object} [options] - {@link https://dmfay.github.io/massive-js/options.html|Update options}.
  * @return {Promise} If updating a single record by its primary key, the
  * modified record; otherwise, an array containing any modified records.
@@ -103,11 +103,7 @@ Table.prototype.update = function (criteria, changes, options = {}) {
     return Promise.reject(new Error('Update requires a hash of fields=>values to update to'));
   } else if (_.isEmpty(changes)) {
     // there's nothing to update, so just return the matching records
-    if (options.single) {
-      return this.findOne(criteria);
-    }
-
-    return this.find(criteria);
+    return this.find(criteria, options);
   }
 
   const update = new Update(this, changes, criteria, options);
@@ -172,10 +168,10 @@ Table.prototype.destroy = function (criteria, options) {
 };
 
 /**
- * Save a document to the database. This function replaces the entire document
- * body.
+ * Save a document to the database. This function will create or replace the
+ * entire document body.
  *
- * @param {Object} doc - The document to write.
+ * @param {Object} doc - The document to persist.
  * @return {Promise} The updated document.
  */
 Table.prototype.saveDoc = function (doc) {

test/table/update.js

@@ -11,11 +11,33 @@ describe('update', function () {
     return db.instance.$pool.end();
   });
 
-  it('updates multiple normal_pk', function () {
-    return db.normal_pk.update({'id >': 2}, {field1: 'zeta'}).then(res => {
+  it('does nothing without changes and returns an array', function () {
+    return db.normal_pk.update({id: 1}, {}).then(res => {
+      assert.equal(res.length, 1);
+      assert.equal(res[0].id, 1);
+      assert.equal(res[0].field1, 'alpha');
+    });
+  });
+
+  it('does nothing without changes and returns an object for unary updates', function () {
+    return db.normal_pk.update(1, {}).then(res => {
+      assert.equal(res.id, 1);
+      assert.equal(res.field1, 'alpha');
+    });
+  });
+
+  it('updates a single record by primary key', function () {
+    return db.normal_pk.update(1, {field1: 'zeta'}).then(res => {
+      assert.equal(res.id, 1);
+      assert.equal(res.field1, 'zeta');
+    });
+  });
+
+  it('updates records by criteria', function () {
+    return db.normal_pk.update({'id >': 2}, {field1: 'eta'}).then(res => {
       assert.equal(res.length, 1);
       assert.equal(res[0].id, 3);
-      assert.equal(res[0].field1, 'zeta');
+      assert.equal(res[0].field1, 'eta');
     });
   });