[Mongoose] lean option を有効にすると MongooseDocument ではなく plain javascript object が返ってくる

Pocket

タイトルで完結していますが、Mongoose で lean option を有効にすると MongooseDocument ではなく plain javascript object が返ってきます。

Documents returned from queries with the lean option enabled are plain javascript objects, not MongooseDocuments. They have no save method, getters/setters or other Mongoose magic applied.

Mongoose ドキュメントではないので、save メソッドや virtual の getter, setter や instance メソッドなどなど Mongoose にしかない便利機能は使えなくなります。

(例) lean option を使った Query

new Query().lean() // true
new Query().lean(true)
new Query().lean(false)
 
Model.find().lean().exec(function (err, docs) {
  docs[0] instanceof mongoose.Document // false
});

業務で lean option を有効にしたときに困ったことがありまして、populate した document の virtual を使っている箇所があり、その部分が動かなくなってしまったことです。

改修方針としては virutal を使わないで、plain js object を引数として渡して使う method を実装して、それを使うように修正しました。

パフォーマンスチューニングをするような状況にならないと lean option を使うことはなさそうですが、そのときは Mongoose の機能を利用した既存処理が動かなくなっていないか注意してみるといいかもしれません。

  1. コメントはまだありません。

  1. トラックバックはまだありません。