Merge pull request mysqljs#586 from jflitton/master

Basic transaction support for connections

Author: jflitton

Readme.md

@@ -701,6 +701,45 @@ connection.query(options, function(err, results) {
 });
 ```
 
+## Transactions
+
+Simple transaction support is available at the connection level:
+
+```js
+connection.beginTransaction(function(err) {
+  if (err) { throw err; }
+  connection.query('INSERT INTO posts SET title=?', title, function(err, result) {
+    if (err) { 
+      connection.rollback(function() {
+        throw err;
+      });
+    }
+
+	var log = 'Post ' + result.insertId + ' added';
+
+	connection.query('INSERT INTO log SET data=?', log, function(err, result) {
+	  if (err) { 
+        connection.rollback(function() {
+          throw err;
+        });
+      }  
+	  connection.commit(function(err) {
+	    if (err) { 
+          connection.rollback(function() {
+            throw err;
+          });
+        }
+	    console.log('success!');
+	  });
+    });
+  });
+});
+```
+Please note that beginTransaction(), commit() and rollback() are simply convenience
+functions that execute the START TRANSACTION, COMMIT, and ROLLBACK commands respectively.
+It is important to understand that many commands in MySQL can cause an implicit commit,
+as described [in the MySQL documentation](http://dev.mysql.com/doc/refman/5.5/en/implicit-commit.html)
+
 ## Error handling
 
 This module comes with a consistent approach to error handling that you should
@@ -973,4 +1012,3 @@ For example, if you have an installation of mysql running on localhost:3306 and
 * Prepared statements
 * setTimeout() for Connection / Query
 * Support for encodings other than UTF-8 / ASCII
-* API support for transactions, similar to [php](http://www.php.net/manual/en/mysqli.quickstart.transactions.php)

lib/Connection.js

@@ -73,6 +73,8 @@ Connection.prototype.connect = function(cb) {
 };
 
 Connection.prototype.changeUser = function(options, cb){
+  cb = cb || function() {};
+
   this._implyConnect();
 
   if (typeof options === 'function') {
@@ -84,6 +86,8 @@ Connection.prototype.changeUser = function(options, cb){
     ? Config.getCharsetNumber(options.charset)
     : this.config.charsetNumber;
 
+  var self = this;
+
   return this._protocol.changeUser({
     user          : options.user || this.config.user,
     password      : options.password || this.config.password,
@@ -93,6 +97,33 @@ Connection.prototype.changeUser = function(options, cb){
   }, cb);
 };
 
+Connection.prototype.beginTransaction = function(cb) {
+  this._implyConnect();
+  
+  var query = Connection.createQuery('START TRANSACTION', cb);
+  query._connection = this;
+  
+  return this._protocol._enqueue(query);
+};
+
+Connection.prototype.commit = function(cb) {
+  this._implyConnect();
+  
+  var query = Connection.createQuery('COMMIT', cb);
+  query._connection = this;
+  
+  return this._protocol._enqueue(query);
+};
+
+Connection.prototype.rollback = function(cb) {
+  this._implyConnect();
+  
+  var query = Connection.createQuery('ROLLBACK', cb);
+  query._connection = this;
+  
+  return this._protocol._enqueue(query);
+};
+
 Connection.prototype.query = function(sql, values, cb) {
   this._implyConnect();
 

test/integration/connection/test-transaction-commit.js

@@ -6,36 +6,32 @@ common.useTestDb(connection);
 
 var table = 'transaction_test';
 connection.query([
-  'CREATE TEMPORARY TABLE `' + table + '` (',
-  '`id` int(11) unsigned NOT NULL AUTO_INCREMENT,',
-  '`title` varchar(255),',
-  'PRIMARY KEY (`id`)',
-  ') ENGINE=InnoDB DEFAULT CHARSET=utf8'
-].join('\n'));
-
-connection.query('START TRANSACTION');
-
-var rowCount = 10;
-for (var i = 1; i <= rowCount; i++) {
+                   'CREATE TEMPORARY TABLE `' + table + '` (',
+                   '`id` int(11) unsigned NOT NULL AUTO_INCREMENT,',
+                   '`title` varchar(255),',
+                   'PRIMARY KEY (`id`)',
+                   ') ENGINE=InnoDB DEFAULT CHARSET=utf8'
+                 ].join('\n'));
+
+connection.beginTransaction(function (err) {
+  assert.ifError(err);
+  
   var row = {
-    id: i,
-    title: 'Row #' + i,
+    id: 1,
+    title: 'Test row'
   };
 
-  connection.query('INSERT INTO ' + table + ' SET ?', row);
-}
-
-connection.query('COMMIT');
-
-var rows = [];
-var query = connection.query('SELECT * FROM ' + table, function(err, _rows) {
-  if (err) throw err;
-
-  rows = _rows;
-});
+  connection.query('INSERT INTO ' + table + ' SET ?', row, function(err) {
+    assert.ifError(err);
 
-connection.end();
+    connection.commit(function(err) {
+      assert.ifError(err);
 
-process.on('exit', function() {
-  assert.equal(rows.length, rowCount);
-});
+      connection.query('SELECT * FROM ' + table, function(err, rows) {
+        assert.ifError(err);
+        connection.end();
+        assert.equal(rows.length, 1);
+      });
+    });
+  });
+});

test/integration/connection/test-transaction-rollback.js

@@ -6,36 +6,32 @@ common.useTestDb(connection);
 
 var table = 'transaction_test';
 connection.query([
-  'CREATE TEMPORARY TABLE `' + table + '` (',
-  '`id` int(11) unsigned NOT NULL AUTO_INCREMENT,',
-  '`title` varchar(255),',
-  'PRIMARY KEY (`id`)',
-  ') ENGINE=InnoDB DEFAULT CHARSET=utf8'
-].join('\n'));
-
-connection.query('START TRANSACTION');
-
-var rowCount = 10;
-for (var i = 1; i <= rowCount; i++) {
+                   'CREATE TEMPORARY TABLE `' + table + '` (',
+                   '`id` int(11) unsigned NOT NULL AUTO_INCREMENT,',
+                   '`title` varchar(255),',
+                   'PRIMARY KEY (`id`)',
+                   ') ENGINE=InnoDB DEFAULT CHARSET=utf8'
+                 ].join('\n'));
+
+connection.beginTransaction(function (err) {
+  assert.ifError(err);
+  
   var row = {
-    id: i,
-    title: 'Row #' + i,
+    id: 1,
+    title: 'Test row'
   };
 
-  connection.query('INSERT INTO ' + table + ' SET ?', row);
-}
-
-connection.query('ROLLBACK');
-
-var rows;
-var query = connection.query('SELECT * FROM ' + table, function(err, _rows) {
-  if (err) throw err;
-
-  rows = _rows;
-});
+  connection.query('INSERT INTO ' + table + ' SET ?', row, function(err) {
+    assert.ifError(err);
 
-connection.end();
+    connection.rollback(function(err) {
+      assert.ifError(err);
 
-process.on('exit', function() {
-  assert.equal(rows.length, 0);
-});
+      connection.query('SELECT * FROM ' + table, function(err, rows) {
+        assert.ifError(err);
+        connection.end();
+        assert.equal(rows.length, 0);
+      });
+    });
+  });
+});