egg-mongoose

Egg's mongoose plugin.

Install

1npm i egg-mongoose --save

Configuration

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

1exports.mongoose = {
2  enable: true,
3  package: 'egg-mongoose',
4};

Simple connection

Config

1// {app_root}/config/config.default.js
2exports.mongoose = {
3  url: 'mongodb://127.0.0.1/example',
4  options: {},
5  // mongoose global plugins, expected a function or an array of function and options
6  plugins: [createdPlugin, [updatedPlugin, pluginOptions]],
7};
8// recommended
9exports.mongoose = {
10  client: {
11    url: 'mongodb://127.0.0.1/example',
12    options: {},
13    // mongoose global plugins, expected a function or an array of function and options
14    plugins: [createdPlugin, [updatedPlugin, pluginOptions]],
15  },
16};

Example

1// {app_root}/app/model/user.js
2module.exports = app => {
3  const mongoose = app.mongoose;
4  const Schema = mongoose.Schema;
5
6  const UserSchema = new Schema({
7    userName: { type: String  },
8    password: { type: String  },
9  });
10
11  return mongoose.model('User', UserSchema);
12}
13
14// {app_root}/app/controller/user.js
15exports.index = function* (ctx) {
16  ctx.body = yield ctx.model.User.find({});
17}

Multiple connections

Config

1// {app_root}/config/config.default.js
2exports.mongoose = {
3  clients: {
4    // clientId, access the client instance by app.mongooseDB.get('clientId')
5    db1: {
6      url: 'mongodb://127.0.0.1/example1',
7      options: {},
8      // client scope plugin array
9      plugins: []
10    },
11    db2: {
12      url: 'mongodb://127.0.0.1/example2',
13      options: {},
14    },
15  },
16  // public scope plugin array
17  plugins: []
18};

Example

1// {app_root}/app/model/user.js
2module.exports = app => {
3  const mongoose = app.mongoose;
4  const Schema = mongoose.Schema;
5  const conn = app.mongooseDB.get('db1'); 
6
7  const UserSchema = new Schema({
8    userName: { type: String },
9    password: { type: String },
10  });
11
12  return conn.model('User', UserSchema);
13}
14
15// {app_root}/app/model/book.js
16module.exports = app => {
17  const mongoose = app.mongoose;
18  const Schema = mongoose.Schema;
19  const conn = app.mongooseDB.get('db2');
20
21  const BookSchema = new Schema({
22    name: { type: String },
23  });
24
25  return conn.model('Book', BookSchema);
26}
27
28// app/controller/user.js
29exports.index = function* (ctx) {
30  ctx.body = yield ctx.model.User.find({}); // get data from db1
31}
32
33// app/controller/book.js
34exports.index = function* (ctx) {
35  ctx.body = yield ctx.model.Book.find({}); // get data from db2
36}

Default config

see config/config.default.js for more detail.

Multi-mongos support

1// {app_root}/config/config.default.js
2exports.mongoose = {
3  client: {
4    url: 'mongodb://mongosA:27501,mongosB:27501',
5    options: {
6      mongos: true,
7    },
8  },
9};

Questions & Suggestions

Please open an issue here.

Contribution

If you are a contributor, follow CONTRIBUTING.

License

MIT

Contributors

jtyjty99999	popomore	atian25	dead-horse	BaffinLee	trylovetom
ChangedenCZD	hardywu	JasinYip	netputer	Wai-Dung	duncup
jinasonlin	legendecas	lzqmyb	DevXiaolan	villins

This project follows the git-contributor spec, auto updated at Sat Aug 12 2023 11:16:17 GMT+0800.