Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinkjs/think-mongoose
Wrap mongoose for ThinkJS 3.x
https://github.com/thinkjs/think-mongoose
mongoose think-extend think-model
Last synced: 4 months ago
JSON representation
Wrap mongoose for ThinkJS 3.x
- Host: GitHub
- URL: https://github.com/thinkjs/think-mongoose
- Owner: thinkjs
- License: mit
- Created: 2017-08-17T03:27:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T16:00:57.000Z (over 1 year ago)
- Last Synced: 2024-03-02T11:03:48.545Z (4 months ago)
- Topics: mongoose, think-extend, think-model
- Language: JavaScript
- Homepage:
- Size: 283 KB
- Stars: 13
- Watchers: 13
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- think-awesome - think-mongoose
README
# think-mongoose
[]()
[]()
Wrap mongoose for ThinkJS 3.x
## Install
```sh
npm install think-mongoose --save
```
## How to use
### Config extend
Change file `src/config/extend.js` (in multi module project, file is `src/common/config/extend.js`), add config:
```js
const mongoose = require('think-mongoose');
module.exports = [
mongoose(think.app)
]
```
When add mongoose extend, it will add some below methods:
* `think.Mongoose` {Class} Model definition base class, model class must be extends this class and implement get schama().
* `think.mongoose` {Function} get mongoose instance
* `ctx.mongoose` {Function} get mongoose instance, it's wrapped from think.mongoose
* `controller.mongoose` {Function} get mongoose instance, it's wrapped from think.mongoose
* `service.mongoose` {Function} get mongoose instance, it's wrapped from think.mongoose
### Config adapter
Change file `src/config/adapter.js` (in multi module project, file is `src/common/config/adapter.js`), add config:
```js
exports.model = {
type: 'mongoose',
mongoose: {
host: '127.0.0.1',
user: '',
password: '',
database: 'test',
useCollectionPlural: false,
options: {}
}
}
```
By default mongoose pluralizes the model name, if you don't want the default action, set `useCollectionPlural: false`.
or config connection string:
```js
exports.model = {
type: 'mongoose',
mongoose: {
connectionString: 'mongodb://user:pass@localhost:port/database',
options: {
config: {
autoIndex: false
}
}
}
}
```
### Create model class
Create model class extends from `think.Mongoose`, like:
```js
// src/model/user.js
const {SchameTypes} = require('mongoose');
module.exports = class extends think.Mongoose {
get schema() {
return {
name: String,
binary: Buffer,
living: Boolean,
updated: { type: Date, default: Date.now },
age: { type: Number, min: 18, max: 65 },
mixed: Schema.Types.Mixed,
_someId: Schema.Types.ObjectId,
array: [],
ofMixed: [SchameTypes.Mixed],
ofObjectId: [SchameTypes.ObjectId],
ofArrays: [[]],
ofArrayOfNumbers: [[Number]],
nested: {
stuff: { type: String, lowercase: true, trim: true }
}
}
}
}
```
Sometime, you want to add some methods to schema, then you can get schema instance by yourself and return instance:
```js
import {Schema} from 'mongoose';
module.exports = class extends think.Mongoose {
get schema() {
const schema = new Schema({ name: String, type: String });
schema.methods.findSimilarTypes = function(cb) {
return this.model('think_Animal').find({ type: this.type }, cb); // model name `think_Animal` must have table prefix
};
return schema;
}
}
```
### Get model instance
You can get mongoose class instance by `think.mongoose`, `ctx.mongoose`, `service.mongoose` or `controller.mongoose`.
```js
module.exports = class extends think.Controller {
async indexAction() {
const user = this.mongoose('user');
const data = await user.find();
}
}
```
If method is defined in schema, then you must be get class instance by yourself
```js
module.exports = class extends think.Controller {
async indexAction() {
const Cls = this.mongoose('user');
const instance = new Cls();
const data = await user.findSimilarTypes(); // findSimilarTypes method is defined in schema.methods.findSimilarTypes
}
}
```
If default model adapter type is not `mongoose`, must be set second argument when get instance by `think.mongoose`, such as:
```js
module.exports = class extends think.Controller {
async indexAction() {
const user = this.mongoose('user', 'mongoose'); // use `mongoose` adapter type
const data = await user.find();
}
}
```
### CRUD
You can use all of mongoose model methods (except `new model & save`) to query or execute documents. Read documents get more information.