Fluxos de change streams

Exemplo

Este exemplo mostra como abrir um change stream na collection myColl e imprimir eventos do change stream conforme eles ocorrem.

O driver armazena evento de change stream em uma variável do tipo ChangeStreamIterable. No exemplo a seguir, especificamos que o driver deve preencher o objeto ChangeStreamIterable com tipos Document . Como resultado, o driver armazena evento individuais de change stream como objeto ChangeStreamDocument .

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch();
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

Uma operação de inserção na collection produz a seguinte saída:

Received a change: ChangeStreamDocument{
   operationType=insert,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   ...
}

Para obter um exemplo executável, consulte a página de exemplo de uso Fique atento às mudanças .

Para saber mais sobre o método watch() , consulte a seguinte documentação da API:

• MongoCollection.watch()

• MongoDatabase.watch()

• MongoClient.watch()

Exemplo

O exemplo de código a seguir mostra como você pode aplicar um pipeline de agregação para configurar seu change stream para receber evento de alteração apenas para operações de inserção e atualização:

MongoCollection<Document> collection = database.getCollection("myColl");
List<Bson> pipeline = Arrays.asList(
        Aggregates.match(Filters.in("operationType", Arrays.asList("insert", "update"))));
ChangeStreamIterable<Document> changeStream = collection.watch(pipeline);
changeStream.forEach(event ->
        System.out.println("Received a change to the collection: " + event));

Uma operação de atualização na collection produz a seguinte saída:

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   ...
}

Crie uma coleção com pré-imagem e pós-imagens habilitadas

Para usar o driver para criar uma collection com as opções de pré-imagem e pós-imagem habilitadas, especifique uma instância de ChangeStreamPreAndPostImagesOptions e chame o método createCollection() , conforme mostrado no exemplo a seguir:

CreateCollectionOptions collectionOptions = new CreateCollectionOptions();
collectionOptions.changeStreamPreAndPostImagesOptions(new ChangeStreamPreAndPostImagesOptions(true));
database.createCollection("myColl", collectionOptions);

Você pode alterar a opção pré-imagem e pós-imagem em uma coleção existente executando o comando collMod a partir do MongoDB Shell. Para saber como executar esta operação, consulte a entrada sobre collMod no manual do servidor MongoDB.

Exemplo de configuração de pré-imagem

O exemplo de código a seguir mostra como você pode configurar um change stream na collection myColl para incluir a pré-imagem e gerar quaisquer eventos de alteração:

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch()
        .fullDocumentBeforeChange(FullDocumentBeforeChange.REQUIRED);
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

O exemplo anterior configura o change stream para utilizar a opção FullDocumentBeforeChange.REQUIRED . Essa opção configura o change stream para exigir pré-imagens para substituir, atualizar e excluir eventos de alteração. Se a pré-imagem não estiver disponível, o driver chamará um erro.

Suponha que você atualize o valor do campo amount em um documento de 150 para 2000. Esse evento de alteração produz a seguinte saída:

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   destinationNamespace=null,
   fullDocument=null,
   fullDocumentBeforeChange=Document{{_id=..., amount=150, ...}},
   ...
}

Para obter uma lista de opções, consulte o FullDocumentBeforeChange Documentação da API.

Exemplo de configuração pós-imagem

O exemplo de código a seguir mostra como você pode configurar um change stream na collection myColl para incluir a pré-imagem e gerar quaisquer eventos de alteração:

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch()
        .fullDocument(FullDocument.WHEN_AVAILABLE);
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

O exemplo anterior configura o change stream para utilizar a opção FullDocument.WHEN_AVAILABLE . Essa opção configura o change stream para retornar a pós-imagem do documento para substituir e atualizar eventos de alteração, se estiver disponível.

Suponha que você atualize o valor do campo color em um documento de "purple" para "pink". O evento de alteração produz a seguinte saída:

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   destinationNamespace=null,
   fullDocument=Document{{_id=..., color=purple, ...}},
   updatedFields={"color": purple},
   ...
}

Para obter uma lista de opções, consulte o FullDocument Documentação da API.