support for custom typeCast #338

Author: sidorares

lib/commands/query.js

@@ -194,7 +194,7 @@ Query.prototype.row = function (packet)
     return this.done();
   }
 
-  var row = new this._rowParser(packet);
+  var row = new this._rowParser(packet, this._fields[this._resultIndex], this.options);
   if (this.onResult) {
     this._rows[this._resultIndex].push(row);
   } else {

lib/compile_text_parser.js

@@ -8,17 +8,37 @@ for (var t in Types) {
   typeNames[Types[t]] = t;
 }
 
+
 function compile (fields, options, config) {
 
+  // node-mysql typeCast compatibility wrapper
+  // see https://github.com/mysqljs/mysql/blob/96fdd0566b654436624e2375c7b6604b1f50f825/lib/protocol/packets/Field.js
+  function wrap(field, type, packet) {
+    return {
+      type: type,
+      length: field.columnLength,
+      db: field.schema,
+      table: field.table,
+      name: field.name,
+      string: function() { return packet.readLengthCodedString(); },
+      buffer: function () { return this.parser.parseLengthCodedBuffer(); },
+      geometry: function () { return this.parser.parseGeometryValue(); }
+    };
+  };
+
   var result = [];
   var i = 0;
   var lvalue = '';
 
-  result.push('(function() { return function TextRow(packet) {');
+  result.push('(function() { return function TextRow(packet, fields, options) {');
   if (options.rowsAsArray) {
     result.push('  var result = new Array(' + fields.length + ')');
   }
 
+  if (typeof options.typeCast === 'function') {
+    result.push('  var wrap = ' + wrap.toString());
+  }
+
   var resultTables = {};
   var resultTablesArray = [];
 
@@ -48,7 +68,14 @@ function compile (fields, options, config) {
     } else {
       lvalue = '  this[' + srcEscape(fields[i].name) + ']';
     }
-    result.push(lvalue + ' = ' + readCodeFor(fields[i].columnType, fields[i].characterSet, config));
+    var readCode = readCodeFor(fields[i].columnType, fields[i].characterSet, config);
+    if (typeof options.typeCast === 'function') {
+      result.push(lvalue + ' = options.typeCast(wrap(fields[' + i + '], ' + srcEscape(typeNames[fields[i].columnType]) + ', packet), function() { return ' + readCode + ';})');
+    } else if (options.typeCast === false) {
+      result.push(lvalue + ' = packet.readLengthCodedBuffer();');
+    } else {
+      result.push(lvalue + ' = ' + readCode);
+    }
   }
 
   if (options.rowsAsArray) {
@@ -59,6 +86,7 @@ function compile (fields, options, config) {
   var src = result.join('\n');
   if (config.debug) {
     console.log('        Compiled text protocol row parser:\n\n');
+    console.log(src);
     var cardinal = require('cardinal');
     console.log(cardinal.highlight(src) + '\n\n');
   }
@@ -72,45 +100,45 @@ function readCodeFor (type, charset, config) {
   case Types.LONG:
   case Types.INT24:
   case Types.YEAR:
-    return 'packet.parseLengthCodedInt();';
+    return 'packet.parseLengthCodedInt()';
   case Types.LONGLONG:
     if (config.supportBigNumbers && config.bigNumberStrings) {
-      return 'packet.parseLengthCodedIntString();';
+      return 'packet.parseLengthCodedIntString()';
     }
-    return 'packet.parseLengthCodedInt();';
+    return 'packet.parseLengthCodedInt()';
   case Types.FLOAT:
   case Types.DOUBLE:
-    return 'packet.parseLengthCodedFloat();';
+    return 'packet.parseLengthCodedFloat()';
   case Types.NULL:
-    return 'null; packet.skip(1);';
+    return 'null; packet.skip(1)';
   case Types.DECIMAL:
   case Types.NEWDECIMAL:
     if (config.decimalNumbers) {
-      return 'packet.parseLengthCodedFloat();';
+      return 'packet.parseLengthCodedFloat()';
     }
-    return 'packet.readLengthCodedString(); //' + type + ' ' + charset;
+    return 'packet.readLengthCodedString()';
   case Types.DATE:
     if (config.dateStrings) {
       return 'packet.readLengthCodedString()';
     }
-    return 'packet.parseDate();';
+    return 'packet.parseDate()';
   case Types.DATETIME:
   case Types.TIMESTAMP:
     if (config.dateStrings) {
       return 'packet.readLengthCodedString()';
     }
-    return 'packet.parseDateTime();';
+    return 'packet.parseDateTime()';
   case Types.TIME:
     return 'packet.readLengthCodedString()';
   case Types.GEOMETRY:
-    return 'packet.parseGeometryValue();';
+    return 'packet.parseGeometryValue()';
   case Types.JSON:
-    return 'JSON.parse(packet.readLengthCodedString());';
+    return 'JSON.parse(packet.readLengthCodedString())';
   default:
     if (charset == Charsets.BINARY) {
-      return 'packet.readLengthCodedBuffer();';
+      return 'packet.readLengthCodedBuffer()';
     } else {
-      return 'packet.readLengthCodedString(); //' + type + ' ' + charset;
+      return 'packet.readLengthCodedString()';
     }
   }
 }

lib/packets/column_definition.js

@@ -61,6 +61,14 @@ addString('table');
 addString('orgTable');
 addString('orgName');
 
+// node-mysql compatibility: alias "db" to "schema"
+Object.defineProperty(ColumnDefinition.prototype, 'db', {get: function () {
+  var start = this._schemaStart;
+  var end = start._shemaLength;
+  return this._buf.utf8Slice(start, end);
+}});
+
+
 ColumnDefinition.prototype.inspect = function () {
   return {
     catalog     : this.catalog,

test/integration/connection/test-typecast.js

@@ -0,0 +1,28 @@
+var common = require('../../common');
+var connection = common.createConnection();
+var assert = require('assert');
+
+connection.query({
+  sql: 'select "foo uppercase" as foo',
+  typeCast: function (field, next) {
+    if (field.type == 'VAR_STRING') {
+      return field.string().toUpperCase();
+    }
+    return next();
+  }
+}, function(err, res) {
+  assert.ifError(err);
+  assert.equal(res[0].foo, 'FOO UPPERCASE')
+});
+
+
+connection.query({
+  sql: 'select "foobar" as foo',
+  typeCast: false
+}, function(err, res) {
+  assert.ifError(err);
+  assert(Buffer.isBuffer(res[0].foo));
+  assert.equal(res[0].foo.toString('utf8'), 'foobar');
+});
+
+connection.end();