Monitorar alterações de dados
Nesta página
Visão geral
Neste guia, você pode aprender como usar um fluxo de alterações para monitorar alterações em tempo real em seus dados. Um change stream é uma funcionalidade do MongoDB Server que permite que seu aplicação se inscreva em alterações de dados em uma collection, banco de dados de dados ou sistema.
Dados de amostra
Os exemplos neste guia usam a collection sample_restaurants.restaurants
dos conjuntos de dados de amostra do Atlas. Para aprender como criar um agrupamento de MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte oInício Rápidodo .
Os exemplos desta página utilizam as seguintes classes Restaurant
, Address
e GradeEntry
como modelos:
public class Restaurant { public ObjectId Id { get; set; } public string Name { get; set; } [ ] public string RestaurantId { get; set; } public string Cuisine { get; set; } public Address Address { get; set; } public string Borough { get; set; } public List<GradeEntry> Grades { get; set; } }
public class Address { public string Building { get; set; } [ ] public double[] Coordinates { get; set; } public string Street { get; set; } [ ] public string ZipCode { get; set; } }
public class GradeEntry { public DateTime Date { get; set; } public string Grade { get; set; } public float? Score { get; set; } }
Observação
Os documentos na collection restaurants
usam a convenção de nomenclatura snake-case. Os exemplos neste guia usam um ConventionPack
para desserializar os campos na coleção em maiúsculas e minúsculas Pascal e mapeá-los para as propriedades na classe Restaurant
.
Para saber mais sobre serialização personalizada, consulte Serialização personalizada.
Abrir um fluxo de alterações
Para abrir um change stream, chame o método Watch()
ou WatchAsync()
. A instância na qual você chama o método determina o escopo de eventos que o change stream escuta. Você pode chamar o método Watch()
ou WatchAsync()
nas seguintes classes:
MongoClient
: Para monitorar todas as alterações no sistema MongoDBDatabase
: Para monitorar alterações em todas as coleções no banco de dadosCollection
: Para monitorar alterações na coleção
O exemplo a seguir abre um fluxo de alteração na coleção restaurants
e gera as alterações conforme elas ocorrem. Selecione a aba Asynchronous ou Synchronous para ver o código correspondente.
var database = client.GetDatabase("sample_restaurants"); var collection = database.GetCollection<Restaurant>("restaurants"); // Opens a change streams and print the changes as they're received using var cursor = await collection.WatchAsync(); await cursor.ForEachAsync(change => { Console.WriteLine("Received the following type of change: " + change.BackingDocument); });
var database = client.GetDatabase("sample_restaurants"); var collection = database.GetCollection<Restaurant>("restaurants"); // Opens a change stream and prints the changes as they're received using (var cursor = collection.Watch()) { foreach (var change in cursor.ToEnumerable()) { Console.WriteLine("Received the following type of change: " + change.BackingDocument); } }
Para começar a observar as alterações, execute o aplicação. Em seguida, em um aplicação ou shell separado, modifique a coleção restaurants
. Atualizar um documento que tenha um valor de resulta na seguinte saída do "name"
"Blarney Castle"
:
{ "_id" : { "_data" : "..." }, "operationType" : "update", "clusterTime" : Timestamp(...), "wallTime" : ISODate("..."), "ns" : { "db" : "sample_restaurants", "coll" : "restaurants" }, "documentKey" : { "_id" : ObjectId("...") }, "updateDescription" : { "updatedFields" : { "cuisine" : "Irish" }, "removedFields" : [], "truncatedArrays" : [] } }
Modificar a saída change stream
Você pode passar o parâmetro pipeline
para os métodos Watch()
e WatchAsync()
para modificar a saída do change stream. Esse parâmetro permite que você observe somente eventos de alteração especificados. Crie o pipeline usando a classe EmptyPipelineDefinition
e anexando os métodos relevantes do estágio de agregação .
Você pode especificar os seguintes estágios de agregação no parâmetro pipeline
:
$addFields
$match
$project
$replaceRoot
$replaceWith
$redact
$set
$unset
Para saber como criar um pipeline de agregação usando a classe PipelineDefinitionBuilder
, consulte Criar um pipeline de agregação no guia Operações com construtores.
O exemplo a seguir usa o parâmetro pipeline
para abrir um fluxo de alterações que registra somente operações de atualização. Selecione a aba Asynchronous ou Synchronous para ver o código correspondente.
var pipeline = new EmptyPipelineDefinition<ChangeStreamDocument<Restaurant>>() .Match(change => change.OperationType == ChangeStreamOperationType.Update); // Opens a change stream and prints the changes as they're received using (var cursor = await _restaurantsCollection.WatchAsync(pipeline)) { await cursor.ForEachAsync(change => { Console.WriteLine("Received the following change: " + change); }); }
var pipeline = new EmptyPipelineDefinition<ChangeStreamDocument<Restaurant>>() .Match(change => change.OperationType == ChangeStreamOperationType.Update); // Opens a change streams and print the changes as they're received using (var cursor = _restaurantsCollection.Watch(pipeline)) { foreach (var change in cursor.ToEnumerable()) { Console.WriteLine("Received the following change: " + change); } }
Para saber mais sobre como modificar a saída do change stream, consulte a seção Modificar a saída do change stream no manual do MongoDB Server .
Modificar Watch()
Comportamento do
Os métodos Watch()
e WatchAsync()
aceitam parâmetros opcionais, que representam opções que você pode utilizar para configurar a operação. Se você não especificar nenhuma opção, o driver não personalizará a operação.
A tabela a seguir descreve as opções que você pode definir para personalizar o comportamento de Watch()
e WatchAsync()
:
Opção | Descrição |
---|---|
| Specifies whether to show the full document after the change, rather
than showing only the changes made to the document. To learn more about
this option, see Include Pre-Images and Post-Images. |
| Specifies whether to show the full document as it was before the change, rather
than showing only the changes made to the document. To learn more about
this option, see Include Pre-Images and Post-Images. |
| Directs Watch() or WatchAsync() to resume returning changes after the
operation specified in the resume token.Each change stream event document includes a resume token as the _id
field. Pass the entire _id field of the change event document that
represents the operation you want to resume after.ResumeAfter is mutually exclusive with StartAfter and StartAtOperationTime . |
| Directs Watch() or WatchAsync() to start a new change stream after the
operation specified in the resume token. Allows notifications to
resume after an invalidate event.Each change stream event document includes a resume token as the _id
field. Pass the entire _id field of the change event document that
represents the operation you want to resume after.StartAfter is mutually exclusive with ResumeAfter and StartAtOperationTime . |
| Directs Watch() or WatchAsync() to return only events that occur after the
specified timestamp.StartAtOperationTime is mutually exclusive with ResumeAfter and StartAfter . |
| Specifies the maximum amount of time, in milliseconds, the server waits for new
data changes to report to the change stream cursor before returning an
empty batch. Defaults to 1000 milliseconds. |
| Starting in MongoDB Server v6.0, change streams support change notifications
for Data Definition Language (DDL) events, such as the createIndexes and dropIndexes events. To
include expanded events in a change stream, create the change stream
cursor and set this parameter to True . |
| Specifies the maximum number of change events to return in each batch of the
response from the MongoDB cluster. |
| Specifies the collation to use for the change stream cursor. |
| Attaches a comment to the operation. |
Incluir pré-imagens e pós-imagens
Importante
Você pode habilitar pré-imagens e pós-imagens em collections somente se seu sistema usar MongoDB v6.0 ou posterior.
Por padrão, quando você executa uma operação em uma collection, o evento de alteração correspondente inclui somente o delta dos campos modificados por essa operação. Para ver o documento completo antes ou depois de uma alteração, crie um objeto ChangeStreamOptions
e especifique as opções FullDocumentBeforeChange
ou FullDocument
. Em seguida, passe o objeto ChangeStreamOptions
para o método Watch()
ou WatchAsync()
.
A pré-imagem é a versão completa de um documento antes de uma alteração. Para incluir a pré-imagem no evento de fluxo de alteração, defina a opção FullDocumentBeforeChange
para um dos seguintes valores:
ChangeStreamFullDocumentBeforeChangeOption.WhenAvailable
: o evento de alteração inclui uma pré-imagem do documento modificado para eventos de alteração somente se a pré-imagem estiver disponível.ChangeStreamFullDocumentBeforeChangeOption.Required
: o evento de alteração inclui uma pré-imagem do documento modificado para eventos de alteração. Se a pré-imagem não estiver disponível, o driver gerará um erro.
A pós-imagem é a versão completa de um documento após uma alteração. Para incluir a pós-imagem na alteração de evento de fluxo, defina a opção FullDocument
para um dos seguintes valores:
ChangeStreamFullDocumentOption.UpdateLookup
: o evento de alteração inclui uma cópia de todo o documento alterado de algum tempo após a alteração.ChangeStreamFullDocumentOption.WhenAvailable
: O evento de alteração inclui uma pós-imagem do documento modificado para eventos de alteração somente se a pós-imagem estiver disponível.ChangeStreamFullDocumentOption.Required
: o evento de alteração inclui uma pós-imagem do documento modificado para eventos de alteração. Se a pós-imagem não estiver disponível, o driver gerará um erro.
O exemplo a seguir abre um fluxo de alteração em uma collection e inclui a pós-imagem de documentos atualizados especificando a opção FullDocument
. Selecione a aba Asynchronous ou Synchronous para ver o código correspondente.
var pipeline = new EmptyPipelineDefinition<ChangeStreamDocument<Restaurant>>() .Match(change => change.OperationType == ChangeStreamOperationType.Update); var options = new ChangeStreamOptions { FullDocument = ChangeStreamFullDocumentOption.UpdateLookup, }; using var cursor = await _restaurantsCollection.WatchAsync(pipeline, options); await cursor.ForEachAsync(change => { Console.WriteLine(change.FullDocument.ToBsonDocument()); });
var pipeline = new EmptyPipelineDefinition<ChangeStreamDocument<Restaurant>>() .Match(change => change.OperationType == ChangeStreamOperationType.Update); var options = new ChangeStreamOptions { FullDocument = ChangeStreamFullDocumentOption.UpdateLookup, }; using (var cursor = _restaurantsCollection.Watch(pipeline, options)) { foreach (var change in cursor.ToEnumerable()) { Console.WriteLine(change.FullDocument.ToBsonDocument()); } }
Executar o exemplo de código anterior e atualizar um documento que tenha um valor de resulta na seguinte saída do "name"
"Blarney Castle"
:
{ "_id" : ObjectId("..."), "name" : "Blarney Castle", "restaurant_id" : "40366356", "cuisine" : "Traditional Irish", "address" : { "building" : "202-24", "coord" : [-73.925044200000002, 40.5595462], "street" : "Rockaway Point Boulevard", "zipcode" : "11697" }, "borough" : "Queens", "grades" : [...] }
Para saber mais sobre pré e pós-imagens, consulte Change Streams com pré e pós-imagens de documentos no manual do MongoDB Server .
Informações adicionais
Para saber mais sobre fluxos de alterações, consulte Change Streams de alterações no manual do MongoDB Server .
Documentação da API
Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API: