データベースのページング

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

1万冊の本がある棚を、1回の応答で送りきることはできません。クライアントは一度に1ページずつ要求し、データベースはそのページだけを送信する必要があります。

skip(n)は最初のn件の一致を飛ばし、limit(n)は続くn件を取得します。1ページ目は先頭から始まるため、pページ目では(p - 1) * size件を飛ばします。クライアントがページ数を把握できるように、同じフィルターで数えた合計件数をページと一緒に送信します。

// エラーログの3ページ目、1ページあたり20件
const entries = await log
    .find({ level: 'error' })
    .skip((3 - 1) * 20)
    .limit(20)
    .toArray();
const total = await log.countDocuments({ level: 'error' });

チャレンジ

簡単

1万冊の本を1回の応答ですべて返すことはできません。GET /booksは、1ページずつ返すようになりました。また、条件に一致する本の総数も返すため、クライアントは「全5ページ中の1ページ目」のように表示できます。

server.jsで、GET /booksを変更します。author、from、toのフィルターはそのままにします。
?page=（デフォルトは1）と?limit=（デフォルトは10）を読み取ります。どちらかが指定されていない場合、または数値でない場合は、デフォルト値を使います。ページ1は最初の本から始まるため、ページpでは(p - 1) * limit冊をスキップし、その次のlimit冊を返します。スキップと切り出しはデータベースに行わせます。
同じフィルターを使って、データベース内のtotalを数えます。これは、このページに表示されている本だけでなく、条件に一致する本すべてを数えます。
ステータス200と配列ではなくオブジェクトを返します。GET /books?limit=2の応答は次のとおりです。
```
{
  "items": [
    { "_id": "6720a1f4c2b9e81d3a5f0c11", "title": "Dune", "author": "Frank Herbert", "year": 1965, "isbn": "9780441013593", "genre": "scifi" },
    { "_id": "6720a1f4c2b9e81d3a5f0c12", "title": "Kindred", "author": "Octavia E. Butler", "year": 1979, "isbn": "9780807083697", "genre": "scifi" }
  ],
  "total": 3
}
```
試してみましょう：GET /books?limit=2を送信すると、DuneとKindredが返り、"total": 3となります。GET /books?limit=2&page=2を送信すると、Emmaだけが返り、"total": 3のままです。GET /books?limit=2&page=3を送信すると、"items": []と"total": 3が返ります。GET /books?author=Jane%20Austen&limit=1を送信すると、Emmaが返り、"total": 1となります。GET /booksを送信すると、3冊すべてがitemsに返ります。

自分で試してみよう

import express from 'express';
import { ObjectId } from 'mongodb';
import { books, ratings } from './db.js';

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 } },
            {
                $lookup: {
                    from: 'authors',
                    localField: 'author',
                    foreignField: 'name',
                    as: 'authorInfo',
                },
            },
        ])
        .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によるデータベースのすべてのレッスン

1ドキュメント

本をドキュメントとして扱うコレクションとデータベース MongoDBへの接続保存されたドキュメントを読み取るドキュメントを挿入する 1件のドキュメントを検索する ObjectIdで検索する数値を比較するクエリフィルター返すフィールドを選択するクエリ結果を並べ替える先頭の結果を残すプロジェクション、ソート、リミット

4構造

データベースモジュールデータベースのページングプロジェクトレッスン

2ドキュメントの変更

3集約

ドキュメントの件数を数えるステージのパイプライン $groupでグループ化するグループ内の平均値グループ結果をフィルタリングする集約パイプライン $lookupで結合する

自分で練習してみよう: Expressプレイグラウンド