Request: expose SqlString.format

[whoughton]

I'm using node-mysql in partnership with node-mysql-libmysqlclient, and one of the things I like about using node-mysql is that I can use it for building Querys, but as of right now only escape and escapeId are exposed. It would seem useful and not harmful to expose SqlString.format as well. I've added it in to my index.js right now and am using it as such.

exports.format   = SqlString.format;

I can submit a pull request if preferred, I just thought this might be an simple change and useful to the community.

As a further example I can then use it in my code as such, with a simple prepare method:

var prepare = function(sql, values) {
    if (typeof values === 'string') { values = [values]; }
    var query = mysql.createQuery(sql, values);
    if (!query.values) { query.values = []; }
    query.sql = mysql.format(query.sql, query.values);

    log("query: %s", query.sql);
    return query;
};

This also allows me to log the SQL query once prepared as well which is nice.

[kai-koch]

👍
But also needs to be documented, when exposed.

[dresende]

I think a pull request will be accepted :)

[whoughton]

Done:
#523

[dresende]

Continuing there.