feat: add options.needFields, default is true

- if needFields = false, return rows result instead of {rows, fields} object result.
- add escape() function

Author: fengmk2

.travis.yml

@@ -2,8 +2,9 @@ language: node_js
 
 node_js:
 - iojs-1
+- iojs-2
 - '0.12'
-- '0.10'
+- '0.11'
 
 env:
   global:

lib/client.js

@@ -24,27 +24,39 @@ function RDSClient(options) {
     return new RDSClient(options);
   }
   this.pool = mysql.createPool(options);
+  // if needFields = false, return rows result instead of {rows, fields} object result.
+  this._needFields = options.needFields === false ? false : true;
 }
 
 var proto = RDSClient.prototype;
 
 proto.query = function (sql, values) {
   var pool = this.pool;
+  var needFields = this._needFields;
   return function (callback) {
     pool.query(sql, values, function (err, rows, fields) {
-      callback(err, { rows: rows, fields: fields });
+      if (needFields) {
+        callback(err, { rows: rows, fields: fields });
+      } else {
+        callback(err, rows);
+      }
     });
   };
 };
 
+proto.escape = function (val) {
+  return this.pool.escape(val);
+};
+
 proto.getConnection = function () {
   var pool = this.pool;
+  var needFields = this._needFields;
   return function (callback) {
     pool.getConnection(function (err, connection) {
       if (err) {
         return callback(err);
       }
-      var conn = new RDSConnection(connection);
+      var conn = new RDSConnection(connection, needFields);
       callback(null, conn);
     });
   };

lib/connection.js

@@ -16,8 +16,9 @@
 
 module.exports = RDSConnection;
 
-function RDSConnection(conn) {
+function RDSConnection(conn, needFields) {
   this.conn = conn;
+  this._needFields = needFields;
 }
 
 var proto = RDSConnection.prototype;
@@ -28,13 +29,22 @@ proto.release = function () {
 
 proto.query = function (sql, values) {
   var conn = this.conn;
+  var needFields = this._needFields;
   return function (callback) {
     conn.query(sql, values, function (err, rows, fields) {
-      callback(err, { rows: rows, fields: fields });
+      if (needFields) {
+        callback(err, { rows: rows, fields: fields });
+      } else {
+        callback(err, rows);
+      }
     });
   };
 };
 
+proto.escape = function (val) {
+  return this.conn.escape(val);
+};
+
 proto.beginTransaction = function () {
   var conn = this.conn;
   return function (callback) {

package.json

@@ -15,7 +15,7 @@
     "cnpm": "npm install --registry=https://registry.npm.taobao.org"
   },
   "dependencies": {
-    "mysql": "~2.5.5"
+    "mysql": "~2.7.0"
   },
   "devDependencies": {
     "autod": "*",

test/ali-rds.test.js

@@ -18,7 +18,7 @@ var assert = require('assert');
 var rds = require('../');
 var config = require('./config');
 
-describe.only('ali-rds.test.js', function () {
+describe('ali-rds.test.js', function () {
   before(function* () {
     this.db = rds(config);
     yield this.db.query('truncate `ali-sdk-test-user`');
@@ -33,6 +33,41 @@ describe.only('ali-rds.test.js', function () {
     });
   });
 
+  describe('options.needFields = false', function () {
+    var options = {};
+    for (var k in config) {
+      options[k] = config[k];
+    }
+    options.needFields = false;
+    var db = rds(options);
+
+    it('should return rows only', function* () {
+      var rows = yield db.query('show tables');
+      assert(rows);
+      assert(Array.isArray(rows));
+    });
+
+    it('should connection query return rows only', function* () {
+      var conn = yield db.getConnection();
+      var rows = yield conn.query('show tables');
+      conn.release();
+      assert(rows);
+      assert(Array.isArray(rows));
+    });
+  });
+
+  describe('escape()', function () {
+    it('should client return escape string', function () {
+      assert.equal(this.db.escape('\'\"?<//\\'), '\'\\\'\\"?<//\\\\\'');
+    });
+
+    it('should connection return escape string', function* () {
+      var conn = yield this.db.getConnection();
+      assert.equal(conn.escape('\'\"?<//\\'), '\'\\\'\\"?<//\\\\\'');
+      conn.release();
+    });
+  });
+
   describe('query()', function () {
     before(function* () {
       yield this.db.query('insert into `ali-sdk-test-user`(name, email, gmt_create, gmt_modified) \