Merge pull request #486 from felixge/pool-connection-event

Add Pool `connection` event, which fires when the Pool has created a new connection

Author: marcuswestin

Readme.md

@@ -214,6 +214,15 @@ pool.getConnection(function(err, connection) {
 });
 ```
 
+If you need to set session variables on the connection before it gets used,
+you can listen to the `connection` event.
+
+```js
+pool.on('connection', function(err, connection) {
+  connection.query('SET SESSION auto_increment_increment=1')
+})
+```
+
 When you are done with a connection, just call `connection.end()` and the
 connection will return to the pool, ready to be used again by someone else.
 

lib/Pool.js

@@ -1,9 +1,13 @@
 var mysql        = require('../');
 var Connection   = require('./Connection');
+var EventEmitter = require('events').EventEmitter;
+var Util         = require('util');
 
 module.exports = Pool;
 
+Util.inherits(Pool, EventEmitter);
 function Pool(options) {
+  EventEmitter.call(this);
   this.config = options.config;
   this.config.connectionConfig.pool = this;
 
@@ -39,6 +43,7 @@ Pool.prototype.getConnection = function (cb) {
         return cb(err);
       }
 
+      this.emit('connection', null, connection);
       return cb(null, connection);
     }.bind(this));
   }

test/integration/pool/test-connection-event.js

@@ -0,0 +1,15 @@
+var common     = require('../../common');
+var assert     = require('assert');
+var Connection = require(common.lib + '/Connection');
+var pool       = common.createPool();
+
+var connectionEventHappened = false;
+pool.on('connection', function(err, connection) {
+  connectionEventHappened = true;
+})
+
+pool.getConnection(function(err, connection) {
+  if (err) throw err;
+  assert.equal(connectionEventHappened, true);
+  pool.end();
+});