1. module promise-mysql
   1. function promise-mysql.connection (config, _connection)
   2. function promise-mysql.createConnection (config)
   3. function promise-mysql.createPool (config)
   4. function promise-mysql.escape (value, stringifyObjects, timeZone)
   5. function promise-mysql.escapeId (value, forbidQualified)
   6. function promise-mysql.format (sql, values, stringifyObjects, timeZone)
   7. function promise-mysql.pool (config)
   8. object promise-mysql.Types
   9. object promise-mysql.connection.prototype
   10. object promise-mysql.helper
   11. object promise-mysql.pool.prototype
2. module promise-mysql.connection
   1. function promise-mysql.connection (config, _connection)
3. module promise-mysql.connection.prototype
   1. function promise-mysql.connection.prototype.beginTransaction ()
   2. function promise-mysql.connection.prototype.changeUser (data)
   3. function promise-mysql.connection.prototype.commit ()
   4. function promise-mysql.connection.prototype.destroy ()
   5. function promise-mysql.connection.prototype.end (data)
   6. function promise-mysql.connection.prototype.escape (value)
   7. function promise-mysql.connection.prototype.escapeId (value)
   8. function promise-mysql.connection.prototype.format (sql, values)
   9. function promise-mysql.connection.prototype.pause ()
   10. function promise-mysql.connection.prototype.ping (data)
   11. function promise-mysql.connection.prototype.query (sql, values)
   12. function promise-mysql.connection.prototype.resume ()
   13. function promise-mysql.connection.prototype.rollback ()
   14. function promise-mysql.connection.prototype.statistics (data)
4. module promise-mysql.helper
   1. function promise-mysql.helper.promiseCallback (functionName, params)
5. module promise-mysql.pool
   1. function promise-mysql.pool (config)
6. module promise-mysql.pool.prototype
   1. function promise-mysql.pool.prototype.end (data)
   2. function promise-mysql.pool.prototype.escape (value)
   3. function promise-mysql.pool.prototype.escapeId (value)
   4. function promise-mysql.pool.prototype.getConnection ()
   5. function promise-mysql.pool.prototype.on (event, fn)
   6. function promise-mysql.pool.prototype.query (sql, values)
   7. function promise-mysql.pool.prototype.releaseConnection (connection)

module promise-mysql

function promise-mysql.connection (config, _connection)

• description and source-code

  connection = function (config, _connection){
      var self = this,
          connect = function(resolve, reject) {
              if (_connection) {
                  self.connection = _connection;
                  resolve();
              } else {
                  self.connection = mysql.createConnection(self.config);
                  self.connection.connect(
                      function(err){
                          if (err) {
                              self.connection.err = err;
                              if (typeof reject === 'function') {
                                  return reject(err);
                              } else {
                                  setTimeout(function(){
                                      connect();
                                  }, 2000);
                                  return;
                              }
                          } else {
                              delete self.connection.err;
                              if (typeof resolve === 'function') {
                                  return resolve();
                              }
                          }
                      }
                  );
  
                  self.connection.on('error', function(err) {
                      console.log('db error', err);
                      self.connection.err = err;
                      if(err.code === 'PROTOCOL_CONNECTION_LOST' || err.code === 'ECONNRESET' || err.code === 'PROTOCOL_ENQUEUE_AFTER_FATAL_ERROR
  ') {
                          connect();
                      }
                  });
              }
          };
  
      this.config = config;
  
      return new Promise(function(resolve, reject) {
          connect(
              function(){
                  return resolve(self);
              },
              function(err){
                  return reject(err);
              }
          );
      });
  }

• example usage

  n/a

function promise-mysql.createConnection (config)

• description and source-code

  createConnection = function (config){
      return new Connection(config);
  }

• example usage

  ...
  
  ```bash
  $ npm install promise-mysql
  ```
  
  Please refer to [mysqljs/mysql](https://github.com/mysqljs/mysql) for documentation on how to use the mysql functions and refer
  to [Bluebird](https://github.com/petkaantonov/bluebird/) for documentation on Bluebird's promises
  
  At the minute only the standard connection (using `.createConnection()`) and the pool
   (using `.createPool()`) is supported. `createPoolCluster` is not implemented yet.
  
  ## Examples
  
  ### Connection
  
  To connect, you simply call `.createConnection()` like you would on mysqljs/mysql:
  ```javascript
  ...

function promise-mysql.createPool (config)

• description and source-code

  createPool = function (config){
      return new Pool(config);
  }

• example usage

  ...
  
  ```bash
  $ npm install promise-mysql
  ```
  
  Please refer to [mysqljs/mysql](https://github.com/mysqljs/mysql) for documentation on how to use the mysql functions and refer
  to [Bluebird](https://github.com/petkaantonov/bluebird/) for documentation on Bluebird's promises
  
  At the minute only the standard connection (using `.createConnection()`) and the pool (using `.createPool()`) is supported. `createPoolCluster` is not implemented yet.
  
  ## Examples
  
  ### Connection
  
  To connect, you simply call `.createConnection()` like you would on mysqljs/mysql:
  ```javascript
  ...

function promise-mysql.escape (value, stringifyObjects, timeZone)

• description and source-code

  function escape(value, stringifyObjects, timeZone) {
    var SqlString = loadClass('SqlString');
  
    return SqlString.escape(value, stringifyObjects, timeZone);
  }

• example usage

  ...
  };
  
  connection.prototype.resume = function() {
      this.connection.resume();
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
  ...

function promise-mysql.escapeId (value, forbidQualified)

• description and source-code

  function escapeId(value, forbidQualified) {
    var SqlString = loadClass('SqlString');
  
    return SqlString.escapeId(value, forbidQualified);
  }

• example usage

  ...
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
      return this.connection.format(sql, values);
  };
  
  module.exports = connection;
  ...

function promise-mysql.format (sql, values, stringifyObjects, timeZone)

• description and source-code

  function format(sql, values, stringifyObjects, timeZone) {
    var SqlString = loadClass('SqlString');
  
    return SqlString.format(sql, values, stringifyObjects, timeZone);
  }

• example usage

  ...
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
      return this.connection.format(sql, values);
  };
  
  module.exports = connection;
  ...

function promise-mysql.pool (config)

• description and source-code

  pool = function (config) {
      this.pool = mysql.createPool(config);
  }

• example usage

  n/a

module promise-mysql.connection

function promise-mysql.connection (config, _connection)

• description and source-code

  connection = function (config, _connection){
      var self = this,
          connect = function(resolve, reject) {
              if (_connection) {
                  self.connection = _connection;
                  resolve();
              } else {
                  self.connection = mysql.createConnection(self.config);
                  self.connection.connect(
                      function(err){
                          if (err) {
                              self.connection.err = err;
                              if (typeof reject === 'function') {
                                  return reject(err);
                              } else {
                                  setTimeout(function(){
                                      connect();
                                  }, 2000);
                                  return;
                              }
                          } else {
                              delete self.connection.err;
                              if (typeof resolve === 'function') {
                                  return resolve();
                              }
                          }
                      }
                  );
  
                  self.connection.on('error', function(err) {
                      console.log('db error', err);
                      self.connection.err = err;
                      if(err.code === 'PROTOCOL_CONNECTION_LOST' || err.code === 'ECONNRESET' || err.code === 'PROTOCOL_ENQUEUE_AFTER_FATAL_ERROR
  ') {
                          connect();
                      }
                  });
              }
          };
  
      this.config = config;
  
      return new Promise(function(resolve, reject) {
          connect(
              function(){
                  return resolve(self);
              },
              function(err){
                  return reject(err);
              }
          );
      });
  }

• example usage

  n/a

module promise-mysql.connection.prototype

function promise-mysql.connection.prototype.beginTransaction ()

• description and source-code

  beginTransaction = function () {
      return promiseCallback.apply(this.connection, ['beginTransaction', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.changeUser (data)

• description and source-code

  changeUser = function (data) {
      return promiseCallback.apply(this.connection, ['changeUser', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.commit ()

• description and source-code

  commit = function () {
      return promiseCallback.apply(this.connection, ['commit', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.destroy ()

• description and source-code

  destroy = function () {
      this.connection.destroy();
  }

• example usage

  ...
  };
  
  connection.prototype.end = function(data) {
      return promiseCallback.apply(this.connection, ['end', arguments]);
  };
  
  connection.prototype.destroy = function() {
      this.connection.destroy();
  };
  
  connection.prototype.pause = function() {
      this.connection.pause();
  };
  
  connection.prototype.resume = function() {
  ...

function promise-mysql.connection.prototype.end (data)

• description and source-code

  end = function (data) {
      return promiseCallback.apply(this.connection, ['end', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.escape (value)

• description and source-code

  escape = function (value) {
      return this.connection.escape(value);
  }

• example usage

  ...
  };
  
  connection.prototype.resume = function() {
      this.connection.resume();
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
  ...

function promise-mysql.connection.prototype.escapeId (value)

• description and source-code

  escapeId = function (value) {
      return this.connection.escapeId(value);
  }

• example usage

  ...
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
      return this.connection.format(sql, values);
  };
  
  module.exports = connection;
  ...

function promise-mysql.connection.prototype.format (sql, values)

• description and source-code

  format = function (sql, values) {
      return this.connection.format(sql, values);
  }

• example usage

  ...
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
      return this.connection.format(sql, values);
  };
  
  module.exports = connection;
  ...

function promise-mysql.connection.prototype.pause ()

• description and source-code

  pause = function () {
      this.connection.pause();
  }

• example usage

  ...
  };
  
  connection.prototype.destroy = function() {
      this.connection.destroy();
  };
  
  connection.prototype.pause = function() {
      this.connection.pause();
  };
  
  connection.prototype.resume = function() {
      this.connection.resume();
  };
  
  connection.prototype.escape = function(value) {
  ...

function promise-mysql.connection.prototype.ping (data)

• description and source-code

  ping = function (data) {
      return promiseCallback.apply(this.connection, ['ping', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.query (sql, values)

• description and source-code

  query = function (sql, values) {
      return promiseCallback.apply(this.connection, ['query', arguments]);
  }

• example usage

  ...
      host: 'localhost',
      user: 'sauron',
      password: 'theonetruering',
      database: 'mordor'
  }).then(function(conn){
      connection = conn;
  
      return connection.query('select `name` from hobbits');
  }).then(function(rows){
      // Logs out a list of hobbits
      console.log(rows);
  });
  ```
  
  You can even chain the promises, using a return within the .then():
  ...

function promise-mysql.connection.prototype.resume ()

• description and source-code

  resume = function () {
      this.connection.resume();
  }

• example usage

  ...
  };
  
  connection.prototype.pause = function() {
      this.connection.pause();
  };
  
  connection.prototype.resume = function() {
      this.connection.resume();
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
  ...

function promise-mysql.connection.prototype.rollback ()

• description and source-code

  rollback = function () {
      return promiseCallback.apply(this.connection, ['rollback', arguments]);
  }

• example usage

  n/a

function promise-mysql.connection.prototype.statistics (data)

• description and source-code

  statistics = function (data) {
      return promiseCallback.apply(this.connection, ['statistics', arguments]);
  }

• example usage

  n/a

module promise-mysql.helper

function promise-mysql.helper.promiseCallback (functionName, params)

• description and source-code

  promiseCallback = function (functionName, params) {
    var self = this;
    params = Array.prototype.slice.call(params, 0);
    return new Promise(function(resolve, reject) {
      params.push(function(err) {
        var args = Array.prototype.slice.call(arguments, 1);
        if (err) {
          return reject(err);
        }
  
        return resolve.apply(this, args);
      });
  
      self[functionName].apply(self, params);
    });
  }

• example usage

  n/a

module promise-mysql.pool

function promise-mysql.pool (config)

• description and source-code

  pool = function (config) {
      this.pool = mysql.createPool(config);
  }

• example usage

  n/a

module promise-mysql.pool.prototype

function promise-mysql.pool.prototype.end (data)

• description and source-code

  end = function (data) {
      return promiseCallback.apply(this.pool, ['end', arguments]);
  }

• example usage

  n/a

function promise-mysql.pool.prototype.escape (value)

• description and source-code

  escape = function (value) {
      return this.pool.escape(value);
  }

• example usage

  ...
  };
  
  connection.prototype.resume = function() {
      this.connection.resume();
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
  ...

function promise-mysql.pool.prototype.escapeId (value)

• description and source-code

  escapeId = function (value) {
      return this.pool.escapeId(value);
  }

• example usage

  ...
  };
  
  connection.prototype.escape = function(value) {
      return this.connection.escape(value);
  };
  
  connection.prototype.escapeId = function(value) {
      return this.connection.escapeId(value);
  };
  
  connection.prototype.format = function(sql, values) {
      return this.connection.format(sql, values);
  };
  
  module.exports = connection;
  ...

function promise-mysql.pool.prototype.getConnection ()

• description and source-code

  function getConnection() {
      return promiseCallback.apply(this.pool, ['getConnection', arguments])
      .then(function(con) {
          return new Connection(null, con);
      });
  }

• example usage

  ...
  });
  
  ```
  
  Get a connection from the pool:
  
  ```javascript
  pool.getConnection().then(function(connection) {
      connection.query('select `name` from hobbits').then(...)
  }).catch(function(err) {
      done(err);
  });
  ```
  
  #### Using/Disposer Pattern with Pool
  ...

function promise-mysql.pool.prototype.on (event, fn)

• description and source-code

  on = function (event, fn) {
      this.pool.on(event, fn);
  }

• example usage

  ...
                  if (typeof resolve === 'function') {
                      return resolve();
                  }
              }
          }
      );
  
      self.connection.on('error', function(err) {
          console.log('db error', err);
          self.connection.err = err;
          if(err.code === 'PROTOCOL_CONNECTION_LOST' || err.code === 'ECONNRESET' || err.code === 'PROTOCOL_ENQUEUE_AFTER_FATAL_ERROR
  ') {
              connect();
          }
      });
  }
  ...

function promise-mysql.pool.prototype.query (sql, values)

• description and source-code

  query = function (sql, values) {
      return promiseCallback.apply(this.pool, ['query', arguments]);
  }

• example usage

  ...
      host: 'localhost',
      user: 'sauron',
      password: 'theonetruering',
      database: 'mordor'
  }).then(function(conn){
      connection = conn;
  
      return connection.query('select `name` from hobbits');
  }).then(function(rows){
      // Logs out a list of hobbits
      console.log(rows);
  });
  ```
  
  You can even chain the promises, using a return within the .then():
  ...

function promise-mysql.pool.prototype.releaseConnection (connection)

• description and source-code

  function releaseConnection(connection) {
      //Use the underlying connection from the mysql-module here:
      return this.pool.releaseConnection(connection.connection);
  }

• example usage

  ...
    password: 'theonetruering',
    database: 'mordor',
    connectionLimit: 10
  });
  
  function getSqlConnection() {
    return pool.getConnection().disposer(function(connection) {
      pool.releaseConnection(connection);
    });
  }
  
  module.exports = getSqlConnection;
  ```
  
  sqlQuery.js:
  ...