README.md

egg-mongoose

Egg's mongoose plugin.

Notice

The plugin is a ahead version of egg-mongoose with some features not supported in the official one.

It's keep up to date with the latest version of official egg-mongoose.

The new features are not supported in the current official one but can be used with this one. Pull Requests to official one link: https://xgithub.com/eggjs/egg-mongoose/pull/60

• place the model files in a custom location
• rename the delegate property to Context.

Install

$ npm i @onewalker/egg-mongoose --save

Configuration

Enable the egg-mongoose plugin by modifying {app_root}/config/plugin.js:

exports.mongoose = {
  enable: true,
  package: '@onewalker/egg-mongoose',
};

Simple Connection

Config

// {app_root}/config/config.default.js
exports.mongoose = {
  url: 'mongodb://127.0.0.1/example',
  options: {},
  // mongoose global plugins, expected a function or an array of function and options
  plugins: [createdPlugin, [updatedPlugin, pluginOptions]],
};

// Recommended
exports.mongoose = {
  // baseDir: 'model', // models in `app/${model}`, // define the dir of model
  // delegate: 'model' // load to `app[delegate]`  // define the delegate
  client: {
    url: 'mongodb://127.0.0.1/example',
    options: {},
    // mongoose global plugins, expected a function or an array of function and options
    plugins: [createdPlugin, [updatedPlugin, pluginOptions]],
  },
};

Example

// {app_root}/app/model/user.js
module.exports = app => {
  const mongoose = app.mongoose;
  const Schema = mongoose.Schema;

  const UserSchema = new Schema({
    userName: { type: String },
    password: { type: String },
  });

  return mongoose.model('User', UserSchema);
};

// {app_root}/app/controller/user.js
exports.index = function* (ctx) {
  ctx.body = yield ctx.model.User.find({});
};

Multiple Connections

Config

// {app_root}/config/config.default.js
exports.mongoose = {
  clients: {
    // clientId, access the client instance by app.mongooseDB.get('clientId')
    db1: {
      url: 'mongodb://127.0.0.1/example1',
      options: {},
      // client scope plugin array
      plugins: [],
    },
    db2: {
      url: 'mongodb://127.0.0.1/example2',
      options: {},
    },
  },
  // public scope plugin array
  plugins: [],
};

Example

// {app_root}/app/{baseDir}/user.js
module.exports = app => {
  const mongoose = app.mongoose;
  const Schema = mongoose.Schema;
  const conn = app.mongooseDB.get('db1');

  const UserSchema = new Schema({
    userName: { type: String },
    password: { type: String },
  });

  return conn.model('User', UserSchema);
};

// {app_root}/app/{baseDir}/book.js
module.exports = app => {
  const mongoose = app.mongoose;
  const Schema = mongoose.Schema;
  const conn = app.mongooseDB.get('db2');

  const BookSchema = new Schema({
    name: { type: String },
  });

  return conn.model('Book', BookSchema);
};

// app/controller/user.js
exports.index = function* (ctx) {
  ctx.body = yield ctx.model.User.find({}); // get data from db1
};

// app/controller/book.js
exports.index = function* (ctx) {
  ctx.body = yield ctx.model.Book.find({}); // get data from db2
};

Default Config

See config/config.default.js for more details.

Multi-Mongos Support

// {app_root}/config/config.default.js
exports.mongoose = {
  client: {
    url: 'mongodb://mongosA:27501,mongosB:27501',
    options: {
      mongos: true,
    },
  },
};

Questions & Suggestions

Please open an issue here.

Contribution

If you are a contributor, follow CONTRIBUTING.

License

MIT