sails-mongo

Waterline adapter for MongoDB.

Heads up

sails-mongo maps the logical id attribute to the required _id physical-layer mongo id. In the current version of sails-mongo, you should not sort by id.

Installation

Install from NPM.

$ npm install sails-mongo --save

Compatibility

sails-mongo 0.11.x has updated to mongo native driver 2.0. If you using mongodb version <=2.4.5, it is recommended that you stick with sails-mongo 0.10.x.

Sails Configuration

Using with Sails v0.11.x (>= 0.10.x)

Add the following config to the config/connections.js file:

module.exports.connections = {

  someMongoDb: {
    adapter: 'sails-mongo',
    host: 'localhost', // defaults to `localhost` if omitted
    port: 27017, // defaults to 27017 if omitted
    user: 'username_here', // or omit if not relevant
    password: 'password_here', // or omit if not relevant
    database: 'database_name_here' // or omit if not relevant
  }
};

And set this particular mongo database as your default in config/models.js:

module.exports.models = {
  'connection': 'someMongoDb'
};

What about mongo urls?

Alternatively, you can specify your Mongo configuration as a URL, e.g.:

module.exports.connections = {

  someMongoDb: {
    adapter: 'sails-mongo',
    url: process.env.MONGOLAB_URI
  }
};

This would be useful if, for instance, your Heroku env variables looked like:

MONGOLAB_URI=mongodb://heroku_app33429348:o9dag2076pnj70p8iqmaj2fiaq@049641.mongolab.com:49641/heroku_app33429348

Legacy usage

####Using with Sails v0.9.x

Add the mongo config to the config/adapters.js file.

module.exports.adapters = {
  'default': 'mongo',

  mongo: {
    module: 'sails-mongo',
    host: 'localhost',
    port: 27017,
    user: 'username',
    password: 'password',
    database: 'your mongo db name here'
  }
};

Note: You can also use the old v0.8.x syntax as well, see next section for details.

Replication/Replica Set can be setup by adding the following options to the mongo object, with your own replica details specified:

replSet: {
  servers: [
    {
      host: 'secondary1.localhost',
      port: 27017 // Will override port from default config (optional)
    },
    {
      host: 'secondary2.localhost',
      port: 27017
    }
  ],
  options: {} // See http://mongodb.github.io/node-mongodb-native/api-generated/replset.html (optional)
}

Note: Replica set configuration is optional.

Using with Sails v0.8.x

module.exports.adapters = {
  'default': 'mongo',

  mongo: {
    module: 'sails-mongo',
    url: 'mongodb://USER:PASSWORD@HOST:PORT/DB'
  }
};

Don't forget that Mongo uses the ObjectId type for ids.

Sails.js

http://sailsjs.org

Waterline

Waterline is a brand new kind of storage and retrieval engine.

It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs. That means you write the same code to get users, whether they live in MySQL, LDAP, MongoDB, or Facebook.

Contributors

Thanks so much to Ted Kulp (@tedkulp) and Robin Persson (@prssn) for building this adapter.

Sails.js License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

schmidlop/sails-mongo