Skip to content
Generic resource pooling for Node.js
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 62 commits ahead, 204 commits behind coopernurse:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib change: ensure pool uses existing client on a LIFO basis (#11) Jul 2, 2019
test
.eslintrc.js chores: use more es6 in codebase and remove extra files from distrbut… Oct 29, 2018
.gitignore
.travis.yml fix: linitng Sep 29, 2018
LICENSE refactor: use promises + implement acquire timeout + remove denque Sep 30, 2018
README.md docs: update readme.md Aug 11, 2019
package-lock.json 2.3.0 Jul 2, 2019
package.json 2.3.0 Jul 2, 2019

README.md

sequelize-pool

npm Travis (.org)

Resource pool. Can be used to reuse or throttle expensive resources such as database connections.

This is a fork from generic-pool@v2.5.

Installation

$ npm install --save sequelize-pool
$ yarn add sequelize-pool

Example

Step 1 - Create pool using a factory object

// Create a MySQL connection pool
var Pool = require('sequelize-pool').Pool;
var mysql2 = require('mysql2/promise');

var pool = new Pool({
    name     : 'mysql',
    create   : function() {
      // return Promise
      return mysql2.createConnection({
        user: 'scott',
        password: 'tiger',
        database:'mydb'
      });
    },
    destroy  : function(client) { client.end(); },
    max      : 10,
    // optional. if you set this, make sure to drain() (see step 3)
    min      : 2,
    // Delay in milliseconds after which available resources in the pool will be destroyed.
    idleTimeoutMillis : 30000,
    // Delay in milliseconds after which pending acquire request in the pool will be rejected.
    acquireTimeoutMillis: 30000,
     // Function, defaults to console.log
    log : true
});

Step 2 - Use pool in your code to acquire/release resources

// acquire connection
pool.acquire().then(connection => {
  client.query("select * from foo", [], function() {
  // return object back to pool
    pool.release(client);
  });
});

Step 3 - Drain pool during shutdown (optional)

If you are shutting down a long-lived process, you may notice that node fails to exit for 30 seconds or so. This is a side effect of the idleTimeoutMillis behaviour -- the pool has a setTimeout() call registered that is in the event loop queue, so node won't terminate until all resources have timed out, and the pool stops trying to manage them.

This behaviour will be more problematic when you set factory.min > 0, as the pool will never become empty, and the setTimeout calls will never end.

In these cases, use the pool.drain() function. This sets the pool into a "draining" state which will gracefully wait until all idle resources have timed out. For example, you can call:

// Only call this once in your application -- at the point you want
// to shutdown and stop using this pool.
pool.drain().then(() => pool.destroyAllNow());

If you do this, your node process will exit gracefully.

Draining

If you know would like to terminate all the resources in your pool before their timeouts have been reached, you can use destroyAllNow() in conjunction with drain():

pool.drain().then(() => pool.destroyAllNow());

One side-effect of calling drain() is that subsequent calls to acquire() will throw an Error.

Pool info

The following functions will let you get information about the pool:

// returns factory.name for this pool
pool.name

// returns number of resources in the pool regardless of
// whether they are free or in use
pool.size

// returns number of unused resources in the pool
pool.available

// returns number of callers waiting to acquire a resource
pool.waiting

// returns number of maxixmum number of resources allowed by pool
pool.maxSize

// returns number of minimum number of resources allowed by pool
pool.minSize

Run Tests

$ npm install
$ npm test
You can’t perform that action at this time.