閱讀314 返回首頁    go 阿裏雲 go 技術社區[雲棲]


MONGOOSE簡要API

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

因此,要使用mongoose,則必須安裝node.js環境以及mongodb數據庫。mongoose使mongodb操作更簡單便捷。可以在github中獲得其源碼,也可以在這裏查看api文檔,英文的,文檔內容較多,因此本文特意總結下mongooseschema數據模型定義以及簡單的增刪改查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`,其他請參考[文檔](https://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的靜態方法很多,如findupdate等,可以通過 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 方法或者 對數組的操作都沒有包含其中,具體以官方文檔為主

最後更新:2017-11-03 10:34:28

  上一篇:go  巧用CSS3濾鏡實現圖片不同渲染效果
  下一篇:go  倪光南:我國物聯網發展有機會趕超國外