ドキュメントの更新

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

本の年を修正するときは、そのフィールドだけを変更し、ほかのフィールドには手を加えないようにします。

updateOne(filter, update) は、フィルターに一致する最初のドキュメントを変更します。更新は演算子で構成されます。$set は指定したフィールドを書き換え、それ以外のフィールドはすべて保持します。演算子を含まない通常のオブジェクトは、"Update document requires atomic operators" というエラーで拒否されます。

const result = await players.updateOne(
    { name: 'Ada' },
    { $set: { score: 120, level: 4 } }
);
result.matchedCount;  // プレイヤーが一致した場合は1、一致しなかった場合は0
result.modifiedCount; // 値がすでに同じだった場合は0

ドキュメントが見つからなかったのか、変更がなかったのかは、modifiedCount ではなく matchedCount で判断します。更新処理はドキュメントを返さないため、findOne でもう一度読み込みます。

チャレンジ

簡単

クライアントは、本全体をもう一度送信せずに、誤った出版年など、本のフィールドを1つだけ修正したいと考えています。

server.jsで、コメント// Add PATCH /books/:id here.の下に、PATCH /books/:idルートを追加します。
現在のGET /books/:idと同じ方法で開始します。parseId(req, res)を呼び出します。IDが不正な場合、parseIdはすでに400で応答し、nullを返しているので、そこで処理を終了します。
リクエスト本文で送られたフィールドだけを変更し、それ以外のフィールドはすべてそのままにします。{ "year": 1966 }という本文は、出版年だけを変更します。
その_idを持つ本がない場合は、ステータス404とエラーを返します。たとえば、{ "error": "No such book" }のようにします。
それ以外の場合は、ステータス200と、現在保存されている本全体を返します。
```
{ "_id": "6720a1f4c2b9e81d3a5f0c11", "title": "Dune", "author": "Frank Herbert", "year": 1966, "isbn": "9780441013593", "genre": "scifi" }
```
試してみましょう：GET /booksを送信し、Duneの_idをコピーします。実行するたびに新しいIDが割り当てられるので、「プレイ」のたびにもう一度コピーしてください。Duneの_idを続けてPATCH /books/を送り、本文には{ "year": 1966 }を指定します。200と、"year": 1966になったDuneが返されます。それ以外のフィールドはすべて変更されず、Dataタブにも同じ内容が表示されます。同じリクエストをもう一度送信しても、今回は何も変更されませんが、本は存在するため、やはり200が返されます。{ "year": 1966 }を付けてPATCH /books/000000000000000000000000を送信すると、404が返されます。PATCH /books/42を送信すると、400が返されます。

自分で試してみよう

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.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;
    await books.insertOne(book);
    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);
});

// ここに PATCH /books/:id を追加します。

app.listen(3000, () => {
    console.log('Bookshelf is running on port 3000');
});