アップサート

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

各読者が本を評価するのは1回だけです。もう一度評価した場合は、評価を追加するのではなく、星の数を変更する必要があります。

{ upsert: true }を指定すると、updateOneはフィルターに一致するドキュメントを更新し、一致するものがない場合は、フィルターのフィールドと更新内容からドキュメントを作成して挿入します。1回の呼び出しで、初回もその後のすべても処理できます。

// ユーザーごとに設定ドキュメントを1つ
await settings.updateOne(
    { user: 'ada' },
    { $set: { theme: 'dark' } },
    { upsert: true }
);

フィルターは、ドキュメントを一意にする条件を指定します。ここでは、ユーザーごとに1つのドキュメントです。呼び出しによって挿入が行われた場合、結果のupsertedIdが設定されます。通常のinsertOneではこれを実現できません。呼び出すたびにドキュメントが追加されます。

チャレンジ

簡単

読者は本を1〜5つ星で評価します。各読者は1冊の本を1回だけ評価します。同じ本を再度評価すると、2つ目の評価が追加されるのではなく、星の数が変更されます。

server.jsで、const books = db.collection('books');の隣に、ratingsという2つ目のコレクションを開きます。各評価は1つのドキュメントです：
```
{ "bookId": "6720a1f4c2b9e81d3a5f0c11", "user": "ada", "stars": 4 }
```
bookIdにはURLのテキストではなく、parseIdが返すObjectIdを保存します。JSONではどちらも同じように見えます。
PUT /books/:id/ratingsを追加します。本文は{ "user": "ada", "stars": 4 }のようになります。このユーザーがすでにこの本を評価している場合は、星の数を変更します。そうでなければ、新しい評価を追加します。1回の呼び出しで両方を行います。ステータス200と評価を返します：{ "user": "ada", "stars": 4 }。
GET /books/:id/ratingsを追加します。ステータス200と、保存されている形式のその本の評価の配列を返します。他の本の評価は含まれてはいけません：
```
[ { "_id": "6720a1f4c2b9e81d3a5f0c21", "bookId": "6720a1f4c2b9e81d3a5f0c11", "user": "ada", "stars": 2 } ]
```
どちらのルートも、不正なIDの場合はparseIdを使用し、400を返します。試してみましょう：GET /booksを送信し、Duneの_idをコピーします。{ "user": "ada", "stars": 4 }を付けてPUT /books/<Dune's _id>/ratingsを送信します。200と{ "user": "ada", "stars": 4 }が返ります。今度は{ "user": "ada", "stars": 2 }を付けてもう一度送信します。200と{ "user": "ada", "stars": 2 }が返ります。GET /books/<Dune's _id>/ratingsを送信すると、Adaの評価が1件、星2つで返ります。{ "user": "bo", "stars": 5 }でDuneを評価して、もう一度一覧を取得すると、評価が2件返ります。「Data」タブにratingsコレクションが表示されます。GET /books/<Kindred's _id>/ratingsは[]を返します。

自分で試してみよう

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');

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

MongoDBによるデータベースのすべてのレッスン

1ドキュメント

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

4構造

データベースモジュールデータベースのページング

2ドキュメントの変更

アップサート

3集約

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

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