Wrap mongoose for ThinkJS 3.x
npm install think-mongoose --saveChange file src/config/extend.js (in multi module project, file is src/common/config/extend.js), add config:
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 instancectx.mongoose{Function} get mongoose instance, it's wrapped from think.mongoosecontroller.mongoose{Function} get mongoose instance, it's wrapped from think.mongooseservice.mongoose{Function} get mongoose instance, it's wrapped from think.mongoose
Change file src/config/adapter.js (in multi module project, file is src/common/config/adapter.js), add config:
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:
exports.model = {
type: 'mongoose',
mongoose: {
connectionString: 'mongodb://user:pass@localhost:port/database',
options: {
config: {
autoIndex: false
}
}
}
}Create model class extends from think.Mongoose, like:
// 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:
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;
}
}You can get mongoose class instance by think.mongoose, ctx.mongoose, service.mongoose or controller.mongoose.
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
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:
module.exports = class extends think.Controller {
async indexAction() {
const user = this.mongoose('user', 'mongoose'); // use `mongoose` adapter type
const data = await user.find();
}
}You can use all of mongoose model methods (except new model & save) to query or execute documents. Read documents http://mongoosejs.com/docs/guide.html get more information.