[轉] Mongoose簡要API

標籤：選項   def   version   TE   關閉   move   controls   配置參數   多個   

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.Schemaconst ObjectId = Schema.Types.ObjectIdconst 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.jsconst Article = require(‘../models/article‘)// staticsArticle.staticFunc ()//methodsconst 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 方法或者 對數組的操作都沒有包含其中，具體以官方文檔為主

[轉] Mongoose簡要API