egg-mongoose-plus/README.md

egg mongoose plus baseed egg-mongoose

# egg-mongoose
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-mongoose.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-mongoose
[travis-image]: https://img.shields.io/travis/eggjs/egg-mongoose.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-mongoose
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-mongoose.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-mongoose?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-mongoose.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-mongoose
[snyk-image]: https://snyk.io/test/npm/egg-mongoose/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-mongoose
[download-image]: https://img.shields.io/npm/dm/egg-mongoose.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-mongoose

Egg's mongoose plus.  允许eggjs项目中同时使用sequelize 和mongoose 的数据库服务

## Install

```bash
$ npm i egg-mongoose-plus --save
```

## Configuration

Change `{app_root}/config/plugin.js` to enable `egg-mongoose` plugin:

```js
exports.mongoose = {
  enable: true,
  package: 'egg-mongoose-plus',
};
```

## Simple connection

### Config

```js
// {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]],
  model: {
    loadModel: true, //是否自动加载模型文件

    //当需要与sequelize同时使用时，必须修改下方两项配置，否则会与sequelize不兼容,而报错
    name: "mongoModel", //加载的模型文件挂载到app对象的属性名，默认是model，如果想与sequelize同时使用，最好单独定义一个名字（sequelize默认挂载app属性名就是model）
    path: "app/mongodb" //模型文件路径，相对于项目跟目录的路径，默认是app/model,如果想与sequelize同时使用，最好单独定义一个路径（sequelize默认模型路径就是app/model）
  },
};
// recommended
exports.mongoose = {
  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]],
    model: {
      loadModel: true, //是否自动加载模型文件

      //当需要与sequelize同时使用时，必须修改下方两项配置，否则会与sequelize不兼容,而报错
      name: "mongoModel", //加载的模型文件挂载到app对象的属性名，默认是model，如果想与sequelize同时使用，最好单独定义一个名字（sequelize默认挂载app属性名就是model）
      path: "app/mongodb" //模型文件路径，相对于项目跟目录的路径，默认是app/model,如果想与sequelize同时使用，最好单独定义一个路径（sequelize默认模型路径就是app/model）
    },
  },
};
```

### Example

```js
// {app_root}/app/mongodb/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 this.app.mongoModel.User.find({});
}
```

## Multiple connections

### Config

```js
// {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: [],
  model: {
    loadModel: true, //是否自动加载模型文件

    //当需要与sequelize同时使用时，必须修改下方两项配置，否则会与sequelize不兼容,而报错
    name: "mongoModel", //加载的模型文件挂载到app对象的属性名，默认是model，如果想与sequelize同时使用，最好单独定义一个名字（sequelize默认挂载app属性名就是model）
    path: "app/mongodb" //模型文件路径，相对于项目跟目录的路径，默认是app/model,如果想与sequelize同时使用，最好单独定义一个路径（sequelize默认模型路径就是app/model）
  },
};
```

### Example

```js
// {app_root}/app/mongodb/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/mongodb/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 this.app.mongoModel.User.find({}); // get data from db1
}

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

### Default config

see [config/config.default.js](config/config.default.js) for more detail.

## Multi-mongos support

```js
// {app_root}/config/config.default.js
exports.mongoose = {
  client: {
    url: 'mongodb://mongosA:27501,mongosB:27501',
    options: {
      mongos: true,
    },
    model: {
      loadModel: true, //是否自动加载模型文件

      //当需要与sequelize同时使用时，必须修改下方两项配置，否则会与sequelize不兼容,而报错
      name: "mongoModel", //加载的模型文件挂载到app对象的属性名，默认是model，如果想与sequelize同时使用，最好单独定义一个名字（sequelize默认挂载app属性名就是model）
      path: "app/mongodb" //模型文件路径，相对于项目跟目录的路径，默认是app/model,如果想与sequelize同时使用，最好单独定义一个路径（sequelize默认模型路径就是app/model）
    },
  },
};
```

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg-mongoose/issues).

## Contribution

If you are a contributor, follow [CONTRIBUTING](https://eggjs.org/zh-cn/contributing.html).

## License

[MIT](LICENSE)