README.md

mysql-pool-cluster

A small convience layer above node-mysql's PoolCluster. It's convienent in situations where you would like load an array of hosts that may be located in a configuration file or system.

Usage

To create a pool cluster, just pass in an array of node options to the constructor. The same types of nodes that the driver supports are supported here, anonymous and identified.

The configuration options of each node are the same as the drivers, except with the addition of an id property. The id property is what is used to distingish between an anonymous and identified node.

Once created, the pool cluster will be just another node-mysql PoolCluster.

Anonymous Nodes

Just supply the node configuration without an id property.

var pool = require('mysql-pool-cluster');

var nodes = [
  { port: 3306 },
  { port: 3307 },
  { port: 3308 },
];

var mysql = pool(nodes);

mysql.getConnection(callback);
mysql.getConnection(callback);
mysql.getConnection(callback);

Identified Nodes

Just supply the node configuration with an id property. The id property should then be used when calling getConnection(id, callback) on the pool.

var pool = require('mysql-pool-cluster');

var nodes = [
  { id: 'app-master', port: 3306 },
  { id: 'app-slave', port: 3307 },
  { id: 'reporting-master', port: 3308 },
  { id: 'reporting-slave', port: 3309 },
];

var mysql = pool(nodes);

mysql.getConnection('app-master', callback);
mysql.getConnection('app-slave', callback);
mysql.getConnection('reporting-master', callback);
mysql.getConnection('reporting-slave', callback);

Single Node

Sometimes you might just need a single node, maybe for testing and an array with a single node in it really just bothers you. For those cases you can just pass an object with the node options instead of an array of options.

var pool = require('mysql-pool-cluster');

var mysql = pool({ port: 3306 });

mysql.getConnection(callback);

License

MIT