Fique atento às mudanças
Abrir um fluxo de alterações
Você pode observar alterações no MongoDB usando o método watch() nos seguintes objetos:
Para cada objeto, o método watch() abre um change stream para emitir documentos de evento de mudança quando eles ocorrem.
O método watch() recebe opcionalmente uma aggregation pipeline que consiste em uma array de estágios de aggregation como o primeiro parâmetro. Os estágios de aggregation filtram e transformam os eventos de mudança.
No trecho a seguir, o estágio $match corresponde a todos os documentos do evento de alteração com um valor runtime menor que 15, filtrando todos os outros.
const pipeline = [ { $match: { runtime: { $lt: 15 } } } ]; const changeStream = collection.watch(pipeline);
O método watch() aceita um objeto options como segundo parâmetro. Consulte os links no final desta seção para obter mais informações sobre as configurações que você pode configurar com este objeto.
O método watch() retorna uma instância de um ChangeStream. Você pode ler eventos de fluxos de mudança iterando sobre eles ou ouvindo eventos.
Selecione a aba que corresponde à maneira como você deseja ler eventos a partir do change stream:
Aviso
Utilizar um ChangeStream no modo EventEmitter e Iterator simultaneamente não é suportado pelo driver e causa um erro. Isso é para evitar comportamentos indefinidos, onde o driver não pode garantir qual consumidor recebe os documentos primeiro.
Exemplos
Iteração
O exemplo seguinte abre um fluxo de alteração na collection haikus no banco de dados do insertDB e imprime eventos de alteração conforme ocorrem:
Observação
Você pode utilizar este exemplo para se conectar a uma instância do MongoDB e interagir com um banco de dados que contém dados de amostra. Para saber mais sobre como se conectar à sua instância do MongoDB e carregar um conjunto de dados de amostra, consulte o Guia de exemplos de uso.
Observação
Trechos de código idênticos
Os trechos de código JavaScript e TypeScript acima são idênticos. Não existem características específicas do TypeScript do condutor relevantes para este caso de utilização.
Quando você executa este código e, em seguida, faça uma alteração na coleção haikus, como executar uma operação de inserção ou exclusão, você pode fazer query no documento do evento de alteração impresso no seu terminal.
Por exemplo, se você inserir um documento na coleção, o código imprime a seguinte saída:
Received change: { _id: { _data: '...' }, operationType: 'insert', clusterTime: new Timestamp({ t: 1675800603, i: 31 }), fullDocument: { _id: new ObjectId("..."), ... }, ns: { db: 'insertDB', coll: 'haikus' }, documentKey: { _id: new ObjectId("...") } }
Observação
Receber documentos completos de atualizações
Os eventos de alteração que contêm informações sobre operações de atualização retornam apenas os campos
modificados por padrão, em vez do documento atualizado completo. Você pode configurar seu fluxo de alterações para também retornar a versão mais atual do documento definindo o campo fullDocument do objeto de opções para "updateLookup" como segue:
const options = { fullDocument: "updateLookup" }; // This could be any pipeline. const pipeline = []; const changeStream = collection.watch(pipeline, options);
Função de ouvinte
O exemplo a seguir abre um fluxo de alteração na coleção haikus no banco de dados insertDB. Vamos criar uma função de ouvinte para receber e imprimir eventos de mudança que ocorram na coleção.
Primeiro, abra o change stream na collection e, em seguida, defina um ouvinte no change stream usando o método on(). Depois de definir o ouvinte, gere um evento de alteração realizando uma alteração na collection.
Para gerar o evento de alteração na coleção, vamos usar o método insertOne() para adicionar um novo documento. Uma vez que insertOne() pode ser executado antes da função de ouvinte pode registrar, usamos um temporizador, definido como simulateAsyncPause para aguardar 1 segundo antes de executar a inserção.
Também usamos simulateAsyncPause após a inserção do documento. Isto fornece tempo suficiente para a função de ouvinte receber o evento de alteração e para o ouvinte completar sua execução antes fechar a instância ChangeStream utilizando o método close().
Observação
Razão para incluir temporizadores
Os cronômetros usados neste exemplo são apenas para fins de demonstração. Eles garantem que haja tempo suficiente para se registrar o ouvinte e faça com que o ouvinte processe o evento de mudança antes de finalizar.
Observação
Trechos de código idênticos
Os trechos de código JavaScript e TypeScript acima são idênticos. Não existem características específicas do TypeScript do condutor relevantes para este caso de utilização.
Visite os seguintes recursos para obter material adicional sobre as classes e métodos mencionados nesta página: