mysql2/lib/pool_connection.js

fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS

var mysql = require('../index.js');
var Connection = mysql.Connection;

var inherits = require('util').inherits;

module.exports = PoolConnection;
inherits(PoolConnection, Connection);
PoolConnection.statementKey = Connection.statementKey;

function PoolConnection(pool, options) {
  Connection.call(this, options);
  this._pool = pool;

  // When a fatal error occurs the connection's protocol ends, which will cause
  // the connection to end as well, thus we only need to watch for the end event
  // and we will be notified of disconnects.
  var connection = this;
  this.on('end', function(err) {
    this._removeFromPool();
  });
  this.on('error', function(err) {
    this._removeFromPool();
  });
}

PoolConnection.prototype.release = function() {
  if (!this._pool || this._pool._closed) {
    return;
  }
  this._pool.releaseConnection(this);
};

// TODO: Remove this when we are removing PoolConnection#end
PoolConnection.prototype._realEnd = Connection.prototype.end;

PoolConnection.prototype.end = function() {
  console.warn(
    'Calling conn.end() to release a pooled connection is ' +
      'deprecated. In next version calling conn.end() will be ' +
      'restored to default conn.end() behavior. Use ' +
      'conn.release() instead.'
  );
  this.release();
};

PoolConnection.prototype.destroy = function() {
  this._removeFromPool();
  return Connection.prototype.destroy.apply(this, arguments);
};

PoolConnection.prototype._removeFromPool = function() {
  if (!this._pool || this._pool._closed) {
    return;
  }

  var pool = this._pool;
  this._pool = null;

  pool._removeConnection(this);
};