3.2を超える最新のMongoDBを使用する$lookup
と、.populate()
ほとんどの場合の代替として使用できます。これには、結合を「エミュレート」するための.populate()
実際の「複数のクエリ」とは対照的に、実際に「サーバー上で」結合を実行するという利点もあります。
したがって、リレーショナルデータベースがどのようにそれを行うかという意味では、実際には「結合」で.populate()
はありません。$lookup
一方、オペレータは、実際にサーバ上の作業を行い、そして多かれ少なかれ類似にある「LEFT JOINを」:
Item.aggregate(
[
{ "$lookup": {
"from": ItemTags.collection.name,
"localField": "tags",
"foreignField": "_id",
"as": "tags"
}},
{ "$unwind": "$tags" },
{ "$match": { "tags.tagName": { "$in": [ "funny", "politics" ] } } },
{ "$group": {
"_id": "$_id",
"dateCreated": { "$first": "$dateCreated" },
"title": { "$first": "$title" },
"description": { "$first": "$description" },
"tags": { "$push": "$tags" }
}}
],
function(err, result) {
}
)
NBザ・.collection.name
ここでは、実際にモデルに割り当てられたとしてMongoDBのコレクションの実際の名前である「文字列」と評価されます。mongooseはデフォルトでコレクション名を「複数化」$lookup
し、引数として実際のMongoDBコレクション名を必要とするため(サーバー操作であるため)、これはコレクション名を直接「ハードコーディング」するのではなく、mongooseコードで使用する便利なトリックです。 。
$filter
配列を使用して不要なアイテムを削除することもできますが、これは実際には、の後にanと条件の両方が続く特別な条件の集約パイプライン最適化により最も効率的な形式です。$lookup
$unwind
$match
これにより、実際には3つのパイプラインステージが1つにまとめられます。
{ "$lookup" : {
"from" : "itemtags",
"as" : "tags",
"localField" : "tags",
"foreignField" : "_id",
"unwinding" : {
"preserveNullAndEmptyArrays" : false
},
"matching" : {
"tagName" : {
"$in" : [
"funny",
"politics"
]
}
}
}}
これは、実際の操作が「最初に結合するようにコレクションをフィルタリング」し、次に結果を返し、配列を「巻き戻す」ため、非常に最適です。両方の方法が採用されているため、結果は16MBのBSON制限を超えません。これは、クライアントにはない制約です。
唯一の問題は、特に結果を配列で表示したい場合に、いくつかの点で「直感に反する」ように見えることです$group
が、元のドキュメント形式に再構築されるため、ここではそれが目的です。
また、現時点$lookup
では、サーバーが使用するのと同じ最終的な構文で実際に書き込むことができないのも残念です。私見、これは修正すべき見落としです。しかし今のところ、シーケンスを使用するだけで機能し、最高のパフォーマンスとスケーラビリティを備えた最も実行可能なオプションです。
補遺-MongoDB3.6以降
ここに示されているパターンは、他のステージがどのようにロールインされるかによってかなり最適化され$lookup
ていますが、通常は両方に固有の「LEFT JOIN」$lookup
とのアクションがpopulate()
、の「最適な」使用法によって無効になっているという点で失敗しています。$unwind
ここでは、空の配列は保持されません。preserveNullAndEmptyArrays
オプションを追加できますが、これにより、上記の「最適化された」シーケンスが無効になり、通常は最適化で組み合わされる3つのステージすべてがそのまま残ります。
MongoDB 3.6は、「サブパイプライン」表現を可能にする「より表現力豊かな」形式で拡張され$lookup
ます。これは、「LEFT JOIN」を保持するという目標を達成するだけでなく、最適なクエリで返される結果を減らし、構文を大幅に簡素化することができます。
Item.aggregate([
{ "$lookup": {
"from": ItemTags.collection.name,
"let": { "tags": "$tags" },
"pipeline": [
{ "$match": {
"tags": { "$in": [ "politics", "funny" ] },
"$expr": { "$in": [ "$_id", "$$tags" ] }
}}
]
}}
])
$expr
「外国人」の値と宣言した「ローカル」の値を一致させるために使用することはMongoDBのは「内部」になりましオリジナルで何をするか、実際にある$lookup
構文。この形式で表現することにより$match
、「サブパイプライン」内で最初の表現を自分で調整できます。
実際、真の「集約パイプライン」として、$lookup
他の関連するコレクションへのレベルの「ネスト」を含め、この「サブパイプライン」式内で集約パイプラインを使用して実行できるほぼすべてのことを実行できます。
それ以上の使用法は、ここでの質問の範囲を少し超えていますが、「ネストされた母集団」に関しても、の新しい使用パターンにより$lookup
、これはほとんど同じになり、完全な使用法では「はるかに」強力になります。
実例
以下に、モデルで静的メソッドを使用する例を示します。その静的メソッドが実装されると、呼び出しは単純に次のようになります。
Item.lookup(
{
path: 'tags',
query: { 'tags.tagName' : { '$in': [ 'funny', 'politics' ] } }
},
callback
)
または、もう少し現代的なものに拡張すると、次のようになります。
let results = await Item.lookup({
path: 'tags',
query: { 'tagName' : { '$in': [ 'funny', 'politics' ] } }
})
.populate()
構造が非常に似ていますが、実際にはサーバーで結合を行っています。完全を期すために、ここでの使用法は、親と子の両方のケースに従って、返されたデータをマングースドキュメントインスタンスにキャストバックします。
それはかなり些細で、適応するのも簡単で、ほとんどの一般的な場合と同じように使用するのも簡単です。
NBここでのasyncの使用は、同封の例を実行するための簡潔さのためです。実際の実装には、この依存関係はありません。
const async = require('async'),
mongoose = require('mongoose'),
Schema = mongoose.Schema;
mongoose.Promise = global.Promise;
mongoose.set('debug', true);
mongoose.connect('mongodb://localhost/looktest');
const itemTagSchema = new Schema({
tagName: String
});
const itemSchema = new Schema({
dateCreated: { type: Date, default: Date.now },
title: String,
description: String,
tags: [{ type: Schema.Types.ObjectId, ref: 'ItemTag' }]
});
itemSchema.statics.lookup = function(opt,callback) {
let rel =
mongoose.model(this.schema.path(opt.path).caster.options.ref);
let group = { "$group": { } };
this.schema.eachPath(p =>
group.$group[p] = (p === "_id") ? "$_id" :
(p === opt.path) ? { "$push": `$${p}` } : { "$first": `$${p}` });
let pipeline = [
{ "$lookup": {
"from": rel.collection.name,
"as": opt.path,
"localField": opt.path,
"foreignField": "_id"
}},
{ "$unwind": `$${opt.path}` },
{ "$match": opt.query },
group
];
this.aggregate(pipeline,(err,result) => {
if (err) callback(err);
result = result.map(m => {
m[opt.path] = m[opt.path].map(r => rel(r));
return this(m);
});
callback(err,result);
});
}
const Item = mongoose.model('Item', itemSchema);
const ItemTag = mongoose.model('ItemTag', itemTagSchema);
function log(body) {
console.log(JSON.stringify(body, undefined, 2))
}
async.series(
[
(callback) => async.each(mongoose.models,(model,callback) =>
model.remove({},callback),callback),
(callback) =>
async.waterfall(
[
(callback) =>
ItemTag.create([{ "tagName": "movies" }, { "tagName": "funny" }],
callback),
(tags, callback) =>
Item.create({ "title": "Something","description": "An item",
"tags": tags },callback)
],
callback
),
(callback) =>
Item.lookup(
{
path: 'tags',
query: { 'tags.tagName' : { '$in': [ 'funny', 'politics' ] } }
},
callback
)
],
(err,results) => {
if (err) throw err;
let result = results.pop();
log(result);
mongoose.disconnect();
}
)
または、async/await
追加の依存関係がなく、ノード8.x以降の場合はもう少し最新です。
const { Schema } = mongoose = require('mongoose');
const uri = 'mongodb://localhost/looktest';
mongoose.Promise = global.Promise;
mongoose.set('debug', true);
const itemTagSchema = new Schema({
tagName: String
});
const itemSchema = new Schema({
dateCreated: { type: Date, default: Date.now },
title: String,
description: String,
tags: [{ type: Schema.Types.ObjectId, ref: 'ItemTag' }]
});
itemSchema.statics.lookup = function(opt) {
let rel =
mongoose.model(this.schema.path(opt.path).caster.options.ref);
let group = { "$group": { } };
this.schema.eachPath(p =>
group.$group[p] = (p === "_id") ? "$_id" :
(p === opt.path) ? { "$push": `$${p}` } : { "$first": `$${p}` });
let pipeline = [
{ "$lookup": {
"from": rel.collection.name,
"as": opt.path,
"localField": opt.path,
"foreignField": "_id"
}},
{ "$unwind": `$${opt.path}` },
{ "$match": opt.query },
group
];
return this.aggregate(pipeline).exec().then(r => r.map(m =>
this({ ...m, [opt.path]: m[opt.path].map(r => rel(r)) })
));
}
const Item = mongoose.model('Item', itemSchema);
const ItemTag = mongoose.model('ItemTag', itemTagSchema);
const log = body => console.log(JSON.stringify(body, undefined, 2));
(async function() {
try {
const conn = await mongoose.connect(uri);
await Promise.all(Object.entries(conn.models).map(([k,m]) => m.remove()));
const tags = await ItemTag.create(
["movies", "funny"].map(tagName =>({ tagName }))
);
const item = await Item.create({
"title": "Something",
"description": "An item",
tags
});
const result = (await Item.lookup({
path: 'tags',
query: { 'tags.tagName' : { '$in': [ 'funny', 'politics' ] } }
})).pop();
log(result);
mongoose.disconnect();
} catch (e) {
console.error(e);
} finally {
process.exit()
}
})()
そして、MongoDB 3.6以降では、$unwind
と$group
ビルドがなくても:
const { Schema, Types: { ObjectId } } = mongoose = require('mongoose');
const uri = 'mongodb://localhost/looktest';
mongoose.Promise = global.Promise;
mongoose.set('debug', true);
const itemTagSchema = new Schema({
tagName: String
});
const itemSchema = new Schema({
title: String,
description: String,
tags: [{ type: Schema.Types.ObjectId, ref: 'ItemTag' }]
},{ timestamps: true });
itemSchema.statics.lookup = function({ path, query }) {
let rel =
mongoose.model(this.schema.path(path).caster.options.ref);
let pipeline = [
{ "$lookup": {
"from": rel.collection.name,
"as": path,
"let": { [path]: `$${path}` },
"pipeline": [
{ "$match": {
...query,
"$expr": { "$in": [ "$_id", `$$${path}` ] }
}}
]
}}
];
return this.aggregate(pipeline).exec().then(r => r.map(m =>
this({ ...m, [path]: m[path].map(r => rel(r)) })
));
};
const Item = mongoose.model('Item', itemSchema);
const ItemTag = mongoose.model('ItemTag', itemTagSchema);
const log = body => console.log(JSON.stringify(body, undefined, 2));
(async function() {
try {
const conn = await mongoose.connect(uri);
await Promise.all(Object.entries(conn.models).map(([k,m]) => m.remove()));
const tags = await ItemTag.insertMany(
["movies", "funny"].map(tagName => ({ tagName }))
);
const item = await Item.create({
"title": "Something",
"description": "An item",
tags
});
let result = (await Item.lookup({
path: 'tags',
query: { 'tagName': { '$in': [ 'funny', 'politics' ] } }
})).pop();
log(result);
await mongoose.disconnect();
} catch(e) {
console.error(e)
} finally {
process.exit()
}
})()