Índices Únicos

Parte da seção Bancos de dados com MongoDB do Journey de Node.js da Coddy. Lição 17 de 29.

Dois livros com o mesmo ISBN nunca devem ser armazenados, e fazer um findOne antes de cada inserção deixa uma brecha: duas solicitações podem não encontrar nada e ambas inserir.

Um índice é uma lista ordenada dos valores de um campo que o banco de dados mantém junto a uma coleção para encontrar documentos rapidamente. Um índice único também recusa um segundo documento com um valor que já esteja armazenado: a inserção lança um MongoServerError com o código 11000, "E11000 duplicate key error".

await users.createIndex({ email: 1 }, { unique: true });

try {
    await users.insertOne({ email: 'ada@example.com' });
} catch (err) {
    if (err.code !== 11000) throw err;
    // o email já está em uso
}

Crie o índice na inicialização, antes de inserir os dados. Criar um índice que já existe não faz nada.

Desafio

Fácil

Dois livros não podem compartilhar o mesmo ISBN, mesmo que duas solicitações cheguem ao mesmo tempo. Deixe o banco de dados rejeitar a duplicata.

Em server.js, no início, crie um índice exclusivo em isbn. Faça isso antes de o código inicial armazenar os três livros com insertMany e aguarde a conclusão com await.
Em POST /books, agora a inserção gera um erro quando o ISBN já está armazenado. Capture esse erro. Quando o valor de code for 11000, responda com o status 409 e um erro, por exemplo { "error": "That ISBN is already on the shelf" }. Gere novamente qualquer outro erro para que o Express responda com 500.
Um livro com um ISBN novo ainda recebe 201 e o livro armazenado, como antes. Teste: Envie POST /books com uma segunda cópia de Dune: { "title": "Dune", "author": "Frank Herbert", "year": 1965, "isbn": "9780441013593", "genre": "scifi" }. Você recebe 409 e o erro. Envie GET /books: você ainda recebe três livros, e a aba Data mostra Dune uma vez. Envie POST /books com { "title": "Beloved", "author": "Toni Morrison", "year": 1987, "isbn": "9781400033416", "genre": "literary" }: você recebe 201.

Experimente você mesmo

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

// Todos os erros retornam { error: message }.
function sendError(res, status, message) {
    res.status(status).json({ error: message });
}

// O :id como um ObjectId, ou null após retornar 400 para um id inválido.
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);
});

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

Teste seus conhecimentos

Esta lição inclui um quiz rápido. Comece a lição para respondê-lo e acompanhar seu progresso.

Pratique por conta própria: Playground de Express

Índices Únicos

Todas as lições de Bancos de dados com MongoDB