$lookupで結合する
CoddyのNode.jsジャーニー「MongoDBによるデータベース」セクションの一部。レッスン 25/29。
本には著者名が保存されており、著者の詳細情報は別のコレクションにあります。クライアントは両方を1つの応答で受け取りたいと考えています。
$lookup ステージは結合を行います。各ドキュメントについて、from コレクション内で foreignField がこのドキュメントの localField と等しいドキュメントを検索し、それらを as で指定した名前の新しい配列フィールドに格納します。
await orders.aggregate([
{ $match: { _id: orderId } },
{ $lookup: {
from: 'customers',
localField: 'customerEmail',
foreignField: 'email',
as: 'customer',
} },
]).toArray();
// [{ _id: ..., customerEmail: 'ada@x.io', customer: [{ email: 'ada@x.io', ... }] }]toArray() は注文の配列を返します。この場合、要素は1つです。最初の要素を取り出すと、注文そのものを取得できます。
localField はパイプライン内のドキュメントに属し、foreignField はもう一方のコレクションに属します。一致するものが1件だけでも、結果は配列です。
from コレクションは、条件に一致するすべてのドキュメントを、as で指定した名前の配列に格納します。提示されたルートはパイプラインの最初の結果を取り出し、要求された1冊の本を返します。
チャレンジ
簡単このステップでは、Aggregation Pipelines のプロジェクトファイル（server.js を含む）ではなく、コース用に用意された書棚 API プロジェクトを開きます。前のレッスンでの作業は、そのレッスンに残ります。server.js を編集する前に、提供されたファイルを読んでください。このコピーには、書棚のルート、ジャンル別の件数と評価上位の集計パイプラインに加えて、初期データとして登録された著者とレスポンス処理が含まれています。
server.js に用意されている GET /books/:id/full ルートで、既存の match の後に lookup ステージを追加します。book.author と author.name が等しい著者を結合します。一致したデータは authorInfo に格納します。最初の結果を取得し、本が見つからない場合に 404 を返す、用意されているコードはそのまま残してください。
試してみましょう: GET /books を実行し、Emma の _id をコピーします。GET /books/<Emma’s _id>/full を実行すると、authorInfo 配列に Jane Austen と born 1775 が含まれた Emma が返されます。著者が不明な本の場合、authorInfo: [] が返されます。有効な形式でも存在しない本の id には、引き続き 404 が返されます。
自分で試してみよう
import express from 'express';
import { MongoClient, ObjectId } from 'mongodb';
import { authorList } from './authors.js';
const client = new MongoClient('mongodb://localhost:27017');
const db = client.db('shelf');
const books = db.collection('books');
const ratings = db.collection('ratings');
const authors = db.collection('authors');
await books.createIndex({ isbn: 1 }, { unique: true });
await books.insertMany([
{ title: 'Dune', author: 'Frank Herbert', year: 1965, isbn: '9780441013593', genre: 'scifi' },
{ title: 'Kindred', author: 'Octavia E. Butler', year: 1979, isbn: '9780807083697', genre: 'scifi' },
{ title: 'Emma', author: 'Jane Austen', year: 1815, isbn: '9780141439587', genre: 'classic' },
]);
await authors.insertMany(authorList);
const app = express();
app.use(express.json());
// すべてのエラーは { error: message } 形式で応答する。
function sendError(res, status, message) {
res.status(status).json({ error: message });
}
// :id を ObjectId に変換する。無効な id の場合は 400 で応答して null を返す。
function parseId(req, res) {
if (ObjectId.isValid(req.params.id)) {
return new ObjectId(req.params.id);
}
sendError(res, 400, 'Not a valid id');
return null;
}
app.get('/', (req, res) => {
res.send('Bookshelf API');
});
app.get('/books', async (req, res) => {
const filter = {};
if (req.query.author) {
filter.author = req.query.author;
}
if (req.query.from || req.query.to) {
filter.year = {};
if (req.query.from) {
filter.year.$gte = Number(req.query.from);
}
if (req.query.to) {
filter.year.$lte = Number(req.query.to);
}
}
const list = await books.find(filter).toArray();
res.json(list);
});
app.post('/books', async (req, res) => {
const book = req.body;
try {
await books.insertOne(book);
} catch (err) {
if (err.code === 11000) {
return sendError(res, 409, 'That ISBN is already on the shelf');
}
throw err;
}
res.status(201).json(book);
});
app.get('/books/newest', async (req, res) => {
const n = Number(req.query.n) || 3;
const list = await books
.find({}, { projection: { title: 1, year: 1, _id: 0 } })
.sort({ year: -1 })
.limit(n)
.toArray();
res.json(list);
});
app.get('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const book = await books.findOne({ _id: id });
if (!book) {
return sendError(res, 404, 'No such book');
}
res.json(book);
});
app.patch('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $set: req.body });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.post('/books/:id/copies', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $inc: { copies: 1 } });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.post('/books/:id/tags', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $push: { tags: req.body.tag } });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.delete('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.deleteOne({ _id: id });
if (result.deletedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.status(204).end();
});
app.put('/books/:id/ratings', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const { user, stars } = req.body;
await ratings.updateOne({ bookId: id, user }, { $set: { stars } }, { upsert: true });
res.json({ user, stars });
});
app.get('/books/:id/ratings', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
res.json(await ratings.find({ bookId: id }).toArray());
});
app.get('/stats', async (req, res) => {
const filter = req.query.genre ? { genre: req.query.genre } : {};
res.json({
books: await books.countDocuments(filter),
ratings: await ratings.countDocuments(),
});
});
app.get('/stats/genres', async (req, res) => {
const genres = await books
.aggregate([{ $group: { _id: '$genre', count: { $sum: 1 } } }])
.toArray();
res.json(genres);
});
app.get('/stats/top', async (req, res) => {
const top = await ratings
.aggregate([
{ $group: { _id: '$bookId', avg: { $avg: '$stars' }, count: { $sum: 1 } } },
{ $match: { count: { $gte: 2 } } },
{ $sort: { avg: -1 } },
{ $limit: 3 },
])
.toArray();
res.json(top);
});
app.get('/books/:id/full', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const [book] = await books
.aggregate([
{ $match: { _id: id } },
])
.toArray();
if (!book) {
return sendError(res, 404, 'No such book');
}
res.json(book);
});
app.listen(3000, () => {
console.log('Bookshelf is running on port 3000');
});
MongoDBによるデータベースのすべてのレッスン
自分で練習してみよう: Expressプレイグラウンド