egg-mongoose

[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-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
[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
[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 plugin.

Install

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

Configuration

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

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

Simple connection

$3

`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]],
};
// 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]],
},
};
`

$3

`js
// {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

$3

`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: []
};
`

$3

`js
// {app_root}/app/model/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/model/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
}
`

$3

see 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,
},
},
};
`

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`.