Change row locking option to be called lock, and added api doc

lib/dialects/abstract/query-generator.js

@@ -956,11 +956,11 @@ module.exports = (function() {
         query = mainQueryItems.join('')
         query = mainQueryItems.join('')
       }
       }
 
 
-      if (this._dialect.supports.rowLocking) {
-        if (options.forUpdate) {
-          query += ' ' + this._dialect.supports.forUpdate
-        } else if (options.forShare) {
+      if (options.lock && this._dialect.supports.lock) {
+        if (options.lock === 'SHARE') {
           query += ' ' + this._dialect.supports.forShare
           query += ' ' + this._dialect.supports.forShare
+        } else {
+          query += ' FOR UPDATE'
         }
         }
       }
       }
 
 

lib/dialects/mysql/index.js

@@ -8,8 +8,7 @@ var MysqlDialect = function(sequelize) {
 MysqlDialect.prototype.supports = _.defaults({
 MysqlDialect.prototype.supports = _.defaults({
   'VALUES ()': true,
   'VALUES ()': true,
   'LIMIT ON UPDATE':true,
   'LIMIT ON UPDATE':true,
-  rowLocking: true,
-  forUpdate: 'FOR UPDATE',
+  lock: true,
   forShare: 'LOCK IN SHARE MODE'
   forShare: 'LOCK IN SHARE MODE'
 }, Abstract.prototype.supports)
 }, Abstract.prototype.supports)
 
 

lib/dialects/postgres/index.js

@@ -9,9 +9,8 @@ PostgresDialect.prototype.supports = _.defaults({
   'RETURNING': true,
   'RETURNING': true,
   'DEFAULT VALUES': true,
   'DEFAULT VALUES': true,
   schemas: true,
   schemas: true,
-  rowLocking: true,
+  lock: true,
   forShare: 'FOR SHARE',
   forShare: 'FOR SHARE',
-  forUpdate: 'FOR UPDATE'
 }, Abstract.prototype.supports)
 }, Abstract.prototype.supports)
 
 
 module.exports = PostgresDialect
 module.exports = PostgresDialect

lib/model.js

@@ -643,6 +643,7 @@ module.exports = (function() {
    * @param  {Number}                    [options.offset]
    * @param  {Number}                    [options.offset]
    * @param  {Object}                    [queryOptions] Set the query options, e.g. raw, specifying that you want raw data instead of built Instances. See sequelize.query for options
    * @param  {Object}                    [queryOptions] Set the query options, e.g. raw, specifying that you want raw data instead of built Instances. See sequelize.query for options
    * @param  {Transaction}               [queryOptions.transaction]
    * @param  {Transaction}               [queryOptions.transaction]
+   * @param  {String}                    [queryOptions.lock] Lock the selected rows in either share or update mode. Possible options are transaction.LOCK.UPDATE and transaction.LOCK.SHARE
    *
    *
    * @see    {Sequelize#query}
    * @see    {Sequelize#query}
    * @return {Promise}
    * @return {Promise}

lib/query-interface.js

@@ -552,6 +552,8 @@ module.exports = (function() {
       })
       })
     }
     }
 
 
+    options.lock = queryOptions.lock
+
     var sql = this.QueryGenerator.selectQuery(tableName, options, factory)
     var sql = this.QueryGenerator.selectQuery(tableName, options, factory)
     queryOptions = Utils._.extend({}, queryOptions, {
     queryOptions = Utils._.extend({}, queryOptions, {
       include: options.include,
       include: options.include,

lib/transaction.js

@@ -40,6 +40,26 @@ Transaction.ISOLATION_LEVELS = {
 }
 }
 
 
 /**
 /**
+ * Possible options for row locking. Used in conjuction with `find` calls:
+ *
+ * ```js
+ * t1 // is a transaction
+ * Model.findAll({
+ *   where: ...
+ * }, {
+ *   transaction: t1,
+ *   lock: t1.LOCK.UPDATE,
+ *   lock: t1.LOCK.SHARE
+ * })
+ * ```
+ * @property LOCK
+ */
+Transaction.LOCK = Transaction.prototype.LOCK = {
+  UPDATE: 'UPDATE',
+  SHARE: 'SHARE'
+}
+
+/**
  * Commit the transaction
  * Commit the transaction
  * 
  * 
  * @return {this}
  * @return {this}

test/transaction.test.js

@@ -94,9 +94,11 @@ describe(Support.getTestDialectTeaser("Transaction"), function () {
             return User.find({
             return User.find({
               where: {
               where: {
                 username: 'jan'
                 username: 'jan'
-              },
-              forUpdate: true
-            }, { transaction: t1 }).then(function (t1Jan) {
+              }
+            }, { 
+              lock: t1.LOCK.UPDATE,
+              transaction: t1
+            }).then(function (t1Jan) {
               self.sequelize.transaction({
               self.sequelize.transaction({
                 isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED
                 isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED
               }, function (t2) {
               }, function (t2) {
@@ -104,8 +106,10 @@ describe(Support.getTestDialectTeaser("Transaction"), function () {
                   where: {
                   where: {
                     username: 'jan'
                     username: 'jan'
                   },
                   },
-                  forUpdate: true
-                }, { transaction: t2}).then(function () {
+                }, { 
+                  lock: t2.LOCK.UPDATE, 
+                  transaction: t2
+                }).then(function () {
                   t2Spy()
                   t2Spy()
                   t2.commit().then(function () {
                   t2.commit().then(function () {
                     expect(t2Spy).to.have.been.calledAfter(t1Spy) // Find should not succeed before t1 has comitted
                     expect(t2Spy).to.have.been.calledAfter(t1Spy) // Find should not succeed before t1 has comitted
@@ -142,9 +146,11 @@ describe(Support.getTestDialectTeaser("Transaction"), function () {
             return User.find({
             return User.find({
               where: {
               where: {
                 username: 'jan'
                 username: 'jan'
-              },
-              forShare: true
-            }, { transaction: t1 }).then(function (t1Jan) {
+              }
+            }, { 
+              lock: t1.LOCK.SHARE,
+              transaction: t1
+            }).then(function (t1Jan) {
               self.sequelize.transaction({
               self.sequelize.transaction({
                 isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED
                 isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED
               }, function (t2) {
               }, function (t2) {
@@ -157,7 +163,9 @@ describe(Support.getTestDialectTeaser("Transaction"), function () {
 
 
                   t2Jan.updateAttributes({
                   t2Jan.updateAttributes({
                     awesome: false
                     awesome: false
-                  }, { transaction: t2 }).then(function () {
+                  }, { 
+                    transaction: t2
+                  }).then(function () {
                     t2UpdateSpy()
                     t2UpdateSpy()
                     t2.commit().then(function () {
                     t2.commit().then(function () {
                       expect(t2FindSpy).to.have.been.calledBefore(t1Spy) // The find call should have returned
                       expect(t2FindSpy).to.have.been.calledBefore(t1Spy) // The find call should have returned
@@ -169,7 +177,9 @@ describe(Support.getTestDialectTeaser("Transaction"), function () {
 
 
                 t1Jan.updateAttributes({
                 t1Jan.updateAttributes({
                   awesome: true
                   awesome: true
-                }, { transaction: t1}).then(function () {
+                }, {
+                  transaction: t1
+                }).then(function () {
                   t1Spy()
                   t1Spy()
                   setTimeout(t1.commit.bind(t1), 2000)
                   setTimeout(t1.commit.bind(t1), 2000)
                 })
                 })