Add sql property to query Error objects

closes #1462
closes #1628
closes #1629

Author: Al Scott

Changes.md

@@ -4,6 +4,10 @@ This file is a manually maintained list of changes for each release. Feel free
 to add your changes here when sending pull requests. Also send corrections if
 you spot any mistakes.
 
+## HEAD
+
+* Add `sql` property to query `Error` objects #1462 #1628 #1629
+
 ## v2.13.0 (2017-01-24)
 
 * Accept regular expression as pool cluster pattern #1572

Readme.md

@@ -1114,6 +1114,9 @@ object. Additionally they typically come with two extra properties:
 * `err.fatal`: Boolean, indicating if this error is terminal to the connection
   object. If the error is not from a MySQL protocol operation, this properly
   will not be defined.
+* `err.sql`: String, contains the full SQL of the failed query. This can be
+  useful when using a higher level interface like an ORM that is generating
+  the queries.
 
 [Error]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error
 [MySQL server error]: http://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html

lib/protocol/sequences/Query.js

@@ -85,6 +85,8 @@ Query.prototype['ErrorPacket'] = function(packet) {
     : undefined;
 
   err.index = this._index;
+  err.sql   = this.sql;
+
   this.end(err, results, fields);
 };
 

test/unit/query/test-error-event.js

@@ -12,6 +12,7 @@ server.listen(common.fakeServerPort, function (err) {
   query.on('error', function (err) {
     assert.ok(err, 'got error');
     assert.equal(err.code, 'ER_PARSE_ERROR');
+    assert.equal(err.sql, 'INVALID SQL');
     assert.ok(!err.fatal);
     connection.destroy();
     server.destroy();