feat: add *beginTransactionScope(scope)

Author: fengmk2

README.md

@@ -108,6 +108,111 @@ console.log(result);
   changedRows: 0 }
 ```
 
+### Update
+
+- Update a row with primary key: `id`
+
+```js
+let row = {
+  id: 123,
+  name: 'fengmk2',
+  otherField: 'other field value',
+  modifiedAt: db.literals.now, // `now()` on db server
+};
+let result = yield db.update('table-name', row);
+console.log(result);
+{ fieldCount: 0,
+  affectedRows: 1,
+  insertId: 0,
+  serverStatus: 2,
+  warningCount: 0,
+  message: '(Rows matched: 1  Changed: 1  Warnings: 0',
+  protocol41: true,
+  changedRows: 1 }
+```
+
+- Update a row with `options.where` and `options.columns`
+
+```js
+let row = {
+  name: 'fengmk2',
+  otherField: 'other field value',
+  modifiedAt: db.literals.now, // `now()` on db server
+};
+let result = yield db.update('table-name', row, {
+  where: { name: row.name },
+  columns: [ 'otherField', 'modifiedAt' ]
+});
+console.log(result);
+{ fieldCount: 0,
+  affectedRows: 1,
+  insertId: 0,
+  serverStatus: 2,
+  warningCount: 0,
+  message: '(Rows matched: 1  Changed: 1  Warnings: 0',
+  protocol41: true,
+  changedRows: 1 }
+```
+
+### Get
+
+- Get a row
+
+```js
+let row = yield db.get('table-name', { name: 'fengmk2' });
+
+=> SELECT * FROM `table-name` WHERE `name` = 'fengmk2'
+```
+
+### Select
+
+- Select all rows
+
+```js
+let rows = yield db.select('table-name');
+
+=> SELECT * FROM `table-name`
+```
+
+- Select rows with condition
+
+```js
+let rows = yield db.select('table-name', {
+  where: {
+    type: 'javascript'
+  },
+  columns: ['author', 'title'],
+  orders: [['id', 'desc']]
+});
+
+=> SELECT `author`, `title` FROM `table-name`
+ WHERE `type` = 'javascript' ORDER BY `id` DESC
+```
+
+### Delete
+
+- Delete with condition
+
+```js
+let result = yield db.delete('table-name', {
+  name: 'fengmk2'
+});
+
+=> DELETE FROM `table-name` WHERE `name` = 'fengmk2'
+```
+
+### Count
+
+- Get count from a table with condition
+
+```js
+let count = yield db.count('table-name', {
+  type: 'javascript'
+});
+
+=> SELECT COUNT(*) AS count FROM `table-name` WHERE `type` = 'javascript';
+```
+
 ### Transactions
 
 beginTransaction, commit or rollback
@@ -126,6 +231,22 @@ try {
 }
 ```
 
+#### Transaction with scope
+
+API: `*beginTransactionScope(scope)`
+
+All query run in scope will under a same transaction.
+We will auto commit or rollback for you.
+
+```js
+var result = yield db.beginTransactionScope(function* (conn) {
+  yield tran.insert(table, row1);
+  yield tran.update(table, row2);
+  return { success: true };
+});
+// if error throw on scope, will auto rollback
+```
+
 ### Raw Queries
 
 - Query with arguments
@@ -162,6 +283,11 @@ TBD
 - *delete(table, where)
 - *count(table, where)
 
+#### Transactions
+
+- *beginTransaction()
+- *beginTransactionScope(scope)
+
 ### Utils
 
 - escape(value, stringifyObjects, timeZone)

lib/client.js

@@ -77,3 +77,21 @@ proto.beginTransaction = function* () {
 
   return new RDSTransaction(conn);
 };
+
+/**
+ * Auto commit or rollback on a transaction scope
+ *
+ * @param  {Function*} scope
+ * @return {Object} scope return result
+ */
+proto.beginTransactionScope = function* (scope) {
+  let tran = yield this.beginTransaction();
+  try {
+    let result = yield scope(tran);
+    yield tran.commit();
+    return result;
+  } catch (err) {
+    yield tran.rollback();
+    throw err;
+  }
+};

test/client.test.js

@@ -225,6 +225,58 @@ describe('client.test.js', function () {
     });
   });
 
+  describe('beginTransactionScope(scope)', function () {
+    it('should beginTransactionScope() error', function* () {
+      let db = rds({});
+      try {
+        yield db.beginTransactionScope(function* () {});
+        throw new Error('should not run this');
+      } catch (err) {
+        assert.equal(err.name, 'RDSClientGetConnectionError');
+      }
+    });
+
+    it('should insert 2 rows in a transaction', function* () {
+      let result = yield this.db.beginTransactionScope(function* (conn) {
+        yield conn.query('insert into ??(name, email, gmt_create, gmt_modified) \
+          values(?, ?, now(), now())',
+          [table, prefix + 'beginTransactionScope1', prefix + 'm@beginTransactionScope1.com']);
+        yield conn.query('insert into ??(name, email, gmt_create, gmt_modified) \
+          values(?, ?, now(), now())',
+          [table, prefix + 'beginTransactionScope2', prefix + 'm@beginTransactionScope1.com']);
+        return true;
+      });
+
+      assert.equal(result, true);
+
+      let rows = yield this.db.query('select * from ?? where email=? order by id',
+        [table, prefix + 'm@beginTransactionScope1.com']);
+      assert.equal(rows.length, 2);
+      assert.equal(rows[0].name, prefix + 'beginTransactionScope1');
+      assert.equal(rows[1].name, prefix + 'beginTransactionScope2');
+    });
+
+    it('should rollback when query fail', function* () {
+      try {
+        yield this.db.beginTransactionScope(function* (conn) {
+          yield conn.query('insert into ??(name, email, gmt_create, gmt_modified) \
+            values(?, ?, now(), now())',
+            [table, prefix + 'beginTransactionScope-fail1', 'm@beginTransactionScope-fail.com']);
+          yield conn.query('insert into ??(name, email, gmt_create, gmt_modified) \
+            valuefail(?, ?, now(), now())',
+            [table, prefix + 'beginTransactionScope-fail12', 'm@beginTransactionScope-fail.com']);
+          return true;
+        });
+      } catch (err) {
+        assert.equal(err.code, 'ER_PARSE_ERROR');
+      }
+
+      let rows = yield this.db.query('select * from ?? where email=? order by id',
+        [table, prefix + 'm@beginTransactionScope-fail.com']);
+      assert.equal(rows.length, 0);
+    });
+  });
+
   describe('get(table, obj, options), select(table, options)', function () {
     before(function* () {
       let result = yield this.db.insert(table, {