Mongoose簡要API

Mongoose是在node.js環境下對mongodb進行便捷操做的對象模型工具

所以，要使用mongoose，則必須安裝node.js環境以及mongodb數據庫。mongoose使mongodb操做更簡單便捷。能夠在github中得到其源碼，也能夠在這裏查看api文檔，英文的，文檔內容較多，所以本文特地總結下mongoose的schema數據模型定義以及簡單的增刪改查api。

connect

connect 用於建立數據庫鏈接

mongoose.connect(uri(s), [options], [callback])
//url(s):數據庫地址,能夠是多個,以`,`隔開
//options:可選,配置參數
//callback:可選,回調
mongoose.connect('mongodb://數據庫地址(包括端口號)/數據庫名稱')

指定用戶鏈接

mongoose.connect('mongodb://用戶名:密碼@127.0.0.1:27017/數據庫名稱')

鏈接多個數據庫

若是你的app中要鏈接多個數據庫，只須要設置多個url以,隔開，同時設置mongos爲true

mongoose.connect('urlA,urlB,...', {
   mongos : true 
})

schema && model

Schema是一種以文件形式存儲的數據庫模型骨架，不具有數據庫的操做能力。

schema能夠理解爲mongoose對錶結構的定義(不單單能夠定義文檔的結構和屬性，還能夠定義文檔的實例方法、靜態模型方法、複合索引等)，每一個schema會映射到mongodb中的一個collection，schema不具有操做數據庫的能力

定義Schema

//語法
new mongoose.Schema({字段...}, [options])

//實例
const mongoose = require('mongoose')
const Schema = mongoose.Schema
const ObjectId = Schema.Types.ObjectId

const ArticleSchema = new Schema({
    title: {
        type: String,
        required: true
    },
    contents: String,
    author: String,
    category: {
        type: ObjectId,
        ref: 'Category' //關聯Category表的_id
    },
    createTime: {
        type: Date,
        default: Date.now
    }
}, {
    connection: 'Article', //模型名稱,
})

字段類型

schema中支持如下字段類型

• String

• Number

• Date

• Buffer

• Boolean

• Mixed

• ObjectId

• Array

schema中不單單能夠設置字段類型，同時還能夠設置默認值（default），關聯文檔（ref），required等。_一旦設置了字段類型，若是出現錯誤，好比某字段類型爲Boolean，而輸入了一個其餘類型，mongoose將會拋出類型錯誤的提示_

options

//經常使用到的`collection`,其餘請參考[文檔](http://www.nodeclass.com/api/mongoose.html#index_Mongoose-Schema)
{
    _id : true, //Boolean, 惟一索引, 若是不須要,能夠設置爲false關閉
    collection : '文檔名稱', //在MongDB中默認使用Model的名字做爲集合的名字，如過須要自定義集合的名字，能夠經過設置這個選項
    versionKey : '__v', //包含文檔的內部修訂,默認的是__v
    autoIndex, 
    capped : Number, //上限設置,此屬性對批量操做有效，用來限制一次對數據庫操做的量
    id, //mongoose分配給每個schema一個虛擬屬性id，它是一個getter。返回的是_id轉換爲字符串後的值
    read,
    safe,
    shardKey,
    strict,
    toJSON,
    toObject
}

Model

Model是由Schema編譯而成的假想（fancy）構造器，具備抽象屬性和行爲。Model的每個實例（instance）就是一個document。document能夠保存到數據庫和對數據庫進行操做。

//語法
mongoose.model(`文檔名稱`, Schema)
//實例
module.exports = mongoose.model(`Article`, ArticleSchema )

Methods 實例方法

Model的實例是document。內置實例方法如 save，能夠經過methods屬性給實例自定義擴展方法

ArticleSchema.methods.methodFunc = function() {
  // body...
}

Statics 靜態方法

model的靜態方法不少，如find，update等，能夠經過 statics屬性給 Model 添加自定義擴展方法

ArticleSchema.statics.staticFunc = function() {
  // body...
}

Methods 和 Statics 的區別

statics是給model添加方法，methods是給實例（instance）添加方法。methods和statics的區別

//接上面代碼,
//module.exports = mongoose.model(`Article`, ArticleSchema )
//將article的model保存爲文件 article.js

const Article = require('../models/article')

// statics
Article.staticFunc ()

//methods
const article = new Article(arguments)
article.methodFunc()

find

find用來查詢多條文檔

Model.find(conditions, [fields], [options], [callback])
conditions <Object> //查詢條件
[fields] <Object> //要查詢的字段
[options] <Object> //查詢配置參數
[callback] <Function> //回調

條件查詢

條件查詢中經常使用屬性

• $or　　　　或關係

• $nor　　　　或關係取反

• $gt　　　　大於

• $gte　　　　大於等於

• $lt　　　　小於

• $lte　　　　小於等於

• $ne　　　　不等於

• $in　　　　在多個值範圍內

• $nin　　　　不在多個值範圍內

• $all　　　　匹配數組中多個值

• $regex　　　　正則，用於模糊查詢

• $size　　　　匹配數組大小

• $maxDistance　　　　範圍查詢，距離（基於LBS）

• $mod　　　　取模運算

• $near　　　　鄰域查詢，查詢附近的位置（基於LBS）

• $exists　　　　字段是否存在

• $elemMatch　　　　匹配內數組內的元素

• $within　　　　範圍查詢（基於LBS）

• $box　　　　範圍查詢，矩形範圍（基於LBS）

• $center　　　　範圍醒詢，圓形範圍（基於LBS）

• $centerSphere　　　　範圍查詢，球形範圍（基於LBS）

• $slice　　　　查詢字段集合中的元素（好比從第幾個以後，第N到第M個元素

如要查詢閱讀量大於500小於600的文章

Article.find({views : {$gte : 500 , $lte : 600}})

options

參看該文檔

findById

findById 用來經過id查詢單條文檔

Model.findById(id, [fields], [options], [callback])

findOne

findOne 用來經過條件查詢單條文檔

Model.findOne(conditions, [fields], [options], [callback])

populate

populate用於查看關聯文檔內容, 也就是查詢 設置了 ref 的字段關聯的 文檔的相關字段

Model.populate(docs, options, [cb(err,doc)])

//示例
yield Article.findOne({_id : id}, {title : 1, author : 1})
    .populate('category', {select : {name : 1, _id : 1}})
//查找_id 爲 id 的文章的category字段對應的category表中的分類名稱和id

//多個關聯表須要使用數組

yield Article.findOne({
        _id: id
    }, {
        title: 1,
        author: 1
    })
    .populate([{
        path: 'comments', //文章的comments字段
        select: {
            _id: 1,
            user: 1,
            text: 1,
        },
    }, {
        path: 'category' //文章的category字段,
        select: {
            fields...
        }
    }])

分頁和排序

yield Article.findOne({
    _id: id
}, {
    title: 1,
    author: 1
}, {
    sort: { 
        createTime: -1, //倒序 desc
        _id: -1
    },
    skip: (page - 1) * pageSize, //page : 當前頁碼, pageSize 每頁顯示條數
    limit: pageSize
})
// sort : -1 => desc , a => asc

模糊查詢

請參看博文《MONGOOSE 多條件模糊查詢的實現》

count

count方法用來統計符合條件的文檔集合的總數

Model.count(conditions, [callback])

update

Model.update(conditions, update, [options], [callback])
//查找並更新
Model.findByIdAndUpdate(id, [update], [options], [callback])
Model.findOneAndUpdate([conditions], [update], [options], [callback])

更新修改器

`$inc` 增減修改器，只對數字有效。
Article.update({_id : id}, {$inc : {views : 1}})
//找到id=_id記錄，而且將 views遞增，返回後的views爲以前的views+1。ps：這個屬性頗有用，對數字直接進行增減。用於更新一些數字（如閱讀數）頗有用
`$set` 指定字段的值，這個字段不存在就建立它。能夠是任何MondoDB支持的類型。
Article.update({_id : id}, {$set : {views : 51, title : '修改後的標題' ...}})
//更新後views爲51,標題爲'修改後的標題'
`$unset` 同上取反，刪除一個字段
Article.update({views : 50}, {$unset : {views : 'remove'}}) 
//執行後: views字段不存在

可選參數, 第三個參數

{
    new: true, //爲true：返回update後的文檔，false：返回update前的，默認是false
    sort: null, //排序條件，與sort函數的參數一致。
    fields: null， //要返回的字段, 與find*的第二個參數一致。
    upsert: null, // 若是是true，表示若是沒有符合查詢選擇器的文檔，mongo將會綜合第一第二個參數向集合插入一個新的文檔
    multi: false, //true:更新匹配到的全部文檔，false：更新匹配到的第一個文檔
}

save

save是一個實例方法，使用時須要先 new Model() 來獲取實例

const article = new Article({
    //字段 => value
    //...
})

yield article.save()

remove

Model.remove(conditions, [callback])
//查找並刪除
Model.findByIdAndRemove(id, [options], [callback])
Model.findOneAndRemove(conditions, [options], [callback])

小結

以上僅僅是對mongoose文檔最簡單的使用總結，諸如 where 方法或者 對數組的操做都沒有包含其中，具體以官方文檔爲主

本文首發在個人博客