node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

sails-hook-sequelize-multi

sails-hook-sequelize-multi

This is a fork of the sails-hook-sequelize project, expanded to support multiple databases and connections. It's a quick and dirty implementation.

Install

Install this hook with:

$ npm install sails-hook-sequelize-multi --save

Configuration

.sailsrc

{
  "hooks": {
    "orm": false,
    "pubsub": false
  }
}
```
 
## Connections files
 
In the `app/config/connections.js` file, list all the connections that you're going to use.
 
```javascript
module.exports.connections = {
  staging: {
    user: 'stagingUser'
    password: 'abcd'
    database: 'staging_db'
    options: {
      host: 'staging.example.com'
      dialect: 'mssql'
      pool: {
        max: 5,
        min: 0,
        idle: 1000
      },
      isolationLevel: 'READ UNCOMMITTED'
    }
  },
  production: {
    user: 'prodUser'
    password: 'abcd'
    database: 'production_db'
    options: {
      host: 'prod.example.com'
      dialect: 'mssql'
      pool: {
        max: 5,
        min: 0,
        idle: 1000
      },
      isolationLevel: 'READ UNCOMMITTED'
    }
  }
};
```
 
## Models config
 
In the `app/config/models.js` file, declare the model that you'd like to use as the default.
For example to use the `staging` database as the default for the connections file above:
 
```javascript
module.exports.models = {
  connection: 'staging'
};
```
 
Or, to use the `production` database as the default:
 
```javascript
module.exports.models = {
  connection: 'production'
};
```
 
## Models
 
No changes to the model code are necessary -- declare the models as you normally do.
 
# How to use
 
Initially, all your existing code will work the same as before.
By default, your Sequelize code will use the default database that you've declared in
the `app/config/models.js` file (see above).
 
For instance, the example below should look very similar to your existing code:
 
```javascript
UserTable.find(option)
.then(function(res) {
  console(res);
}).catch(function(err) {
  console(err);
});
```
 
However, if you'd like to target a specific database, you can declare that right after the table name:
 
```javascript
UserTable.staging.find(option)
.then(function(res) {
  console(res);
}).catch(function(err) {
  console(err);
});
```
 
or
 
```javascript
var dbname = 'staging';    // db name is set elsewhere in the code
 
UserTable[dbname].find(option)
.then(function(res) {
  console(res);
}).catch(function(err) {
  console(err);
});
```
 
This also works if you're using the `sequelize` object to execute raw queries
 
```javascript
var dbname = 'production';    // db name is set elsewhere in the code
var sqlString = 'SELECT getdate()';
 
sequelize[dbname].query(sqlString)
.then(function(res) {
  console(res);
}).catch(function(err) {
  console(err);
});
```
 
# Caveats
 
At the moment, associations do not work for the "extra" databases. In the example above,
the "production" tables would have associations, but the "staging" tables are not because
they are not the default. This will be addressed in a future version.
 
#License
[MIT](./LICENSE)