https://github.com/eggjs/egg-mongoose

https://github.com/eggjs/egg-mongoose

egg egg-plugin mongodb mongodb-orm mongoose

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/eggjs/egg-mongoose
• Owner: eggjs
• License: mit
• Created: 2017-02-15T07:44:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-12T00:16:15.000Z (9 months ago)
• Last Synced: 2024-04-14T10:16:00.159Z (7 months ago)
• Topics: egg, egg-plugin, mongodb, mongodb-orm, mongoose
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 437
• Watchers: 27
• Forks: 104
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egg - egg-mongoose - mongoose plugin for egg   (仓库 / 插件)
• awesome-egg - egg-mongoose - mongoose plugin for egg (Plugins)

README

        
# egg-mongoose

[![NPM version][npm-image]][npm-url]

[![Run tests](https://github.com/eggjs/egg-mongoose/actions/workflows/autoUnitTest.yml/badge.svg)](https://github.com/eggjs/egg-mongoose/actions/workflows/autoUnitTest.yml)

[![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

### 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]],

};

// 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]],

  },

};

```

### Example

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

### 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: []

};

```

### Example

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

}

```

### 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,

    },

  },

};

```

## 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)

## Contributors

|[
jtyjty99999](https://github.com/jtyjty99999)
|[
popomore](https://github.com/popomore)
|[
atian25](https://github.com/atian25)
|[
dead-horse](https://github.com/dead-horse)
|[
BaffinLee](https://github.com/BaffinLee)
|[
trylovetom](https://github.com/trylovetom)
|

| :---: | :---: | :---: | :---: | :---: | :---: |

|[
ChangedenCZD](https://github.com/ChangedenCZD)
|[
hardywu](https://github.com/hardywu)
|[
JasinYip](https://github.com/JasinYip)
|[
netputer](https://github.com/netputer)
|[
Wai-Dung](https://github.com/Wai-Dung)
|[
duncup](https://github.com/duncup)
|

[
jinasonlin](https://github.com/jinasonlin)
|[
legendecas](https://github.com/legendecas)
|[
lzqmyb](https://github.com/lzqmyb)
|[
DevXiaolan](https://github.com/DevXiaolan)
|[
villins](https://github.com/villins)


This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Aug 12 2023 11:16:17 GMT+0800`.