集約パイプライン

CoddyのNode.jsジャーニー「MongoDBによるデータベース」セクションの一部。レッスン 24/29。

「高評価」リストには、平均、最低評価数、並べ替え、件数制限が必要です。それぞれが1つのステージです。

$matchは、findのように、フィルターを通過したドキュメントを残します。$avgは、$group内でフィールドの平均を計算します。ステージは記述した順に実行され、それぞれのステージが受け取るのは、直前のステージを通過したものだけです。$groupの前にある$matchは、保存されているドキュメントをフィルターします。$groupの後にある$matchは、{ $match: { orders: { $gte: 3 } } }のように、グループが作成したフィールドを使ってグループをフィルターします。1つの$groupで、spent: { $sum: '$total' }やorders: { $sum: 1 }のように、複数のフィールドを同時に作成できます。

await orders.aggregate([
    { $match: { status: 'paid' } },
    { $group: { _id: '$customer', spent: { $sum: '$total' } } },
    { $sort: { spent: -1 } },
    { $limit: 5 },
]).toArray();

$sortと$limitはカーソルの場合と同じ引数を取りますが、パイプラインでは記述した順に実行されます。$sortの前に$limitを置くと、任意の5件を残し、その5件だけを並べ替えます。

チャレンジ

簡単

このステップでは、$group によるグループ化で作成したプロジェクトファイル（server.jsを含む）ではなく、コースで用意された書棚APIプロジェクトを開きます。これまでの作業は、元のレッスン内に残っています。server.jsを編集する前に、用意されているファイルを読んでください。このコピーには書棚のルートとジャンル別の件数集計が含まれています。

書棚には「評価の高い本」のリスト、つまり平均星数が最も高い3冊の本が必要です。リストに載るには少なくとも2件の評価が必要です。運よく5つ星評価を1件もらっただけでは、上位には入りません。

server.jsにGET /stats/topルートを追加します。これはbooksではなく、ratingsコレクションに対して集約を実行します。
評価をbookIdごとにグループ化します。各グループには3つのフィールドを設定します。_idは本のID、avgはその本のstarsの平均、countは評価の件数です。1つの$groupステージでavgとcountの両方を計算できます。
countが2以上のグループだけを残します。このルールは個々の評価ではなく本のグループに適用するため、このステージはグループ化の後に置きます。
グループをavgの高い順に並べ、先頭の3件を残します。
ステータス200と配列を返します。各要素は次の3つのフィールドだけを持ちます。
```
[
  { "_id": "6720a1f4c2b9e81d3a5f0c11", "avg": 4.5, "count": 2 },
  { "_id": "6720a1f4c2b9e81d3a5f0c12", "avg": 3, "count": 2 }
]
```
_idは本の_idなので、クライアントはそのIDをGET /books/に続けて指定すれば本を取得できます。評価が2件以上ある本が3冊未満の場合、配列は3件より短くなります。試してみましょう。「Run」を実行するたびにratingsが空になるので、最後に「Run」を実行した後で以下のリクエストを送ってください。GET /booksを送信し、Dune、Kindred、Emmaの_idをコピーします。PUT /books/<Dune's _id>/ratingsを{ "user": "ada", "stars": 5 }とともに送信し、続けて{ "user": "bo", "stars": 4 }でもう一度送信します。Kindredにも同じように評価を付けます。adaから3つ星、boからも3つ星を付けます。Emmaには{ "user": "ada", "stars": 5 }で1回だけ評価を付けます。GET /stats/topを送信すると、Dune（avg 4.5、count 2）、次にKindred（avg 3、count 2）が返ります。Emmaは評価が1件しかないため、結果に含まれません。Emmaが先頭に表示される場合、件数のフィルターがグループ化の前に実行されているか、まったく実行されていません。

自分で試してみよう

import express from 'express';
import { MongoClient, ObjectId } from 'mongodb';

const client = new MongoClient('mongodb://localhost:27017');
const db = client.db('shelf');
const books = db.collection('books');
const ratings = db.collection('ratings');

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' },
]);

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.listen(3000, () => {
    console.log('Bookshelf is running on port 3000');
});