Menu Docs
Página inicial do Docs
/ /
Alterar eventos
Página inicial do Docs
/
Manual do banco de dados
/
Fluxos de alterações
/
Alterar eventos
Página inicial do Docs
/
Manual do banco de dados
/
Fluxos de alterações
/
Alterar eventos

update Evento

Resumo

update

Um evento update ocorre quando uma operação atualiza um documento em uma coleção.

Observação

Desambiguação

Para saber mais sobre eventos que ocorrem quando as opções de coleta são modificadas, consulte o evento modify .

Descrição

Campo
Tipo
Descrição

_id

Documento

Um objeto BSON que serve como um identificador para o evento de fluxo de alterações. Este valor é utilizado como resumeToken para o parâmetro resumeAfter ao retomar um fluxo de alteração. O objeto _id tem o seguinte formulário:

{
   "_data" : <BinData|hex string>
}

O tipo de _data depende das versões do MongoDB e, em alguns casos, da versão de compatibilidade de recursos (fCV) no momento da abertura ou retomada do fluxo de alterações. Consulte Tokens de currículo para obter a lista completa de _data tipos.

Para obter um exemplo de como retomar um fluxo de alterações por resumeToken, consulte Retomar um fluxo de alterações.

clusterTime

Timestamp

clusterTime é o registro de data/hora da entrada de registro opcional associada ao evento.

Devido aos limites de tamanho do oplog , transações com vários documentos podem criar várias entradas no oplog. Em uma transação, os eventos de change stream encenados em uma determinada entrada do oplog compartilham o mesmo clusterTime.

Em clusters fragmentados, eventos com o mesmo clusterTime podem não estar relacionados à mesma transação. Alguns eventos não estão nem um pouco relacionados a uma transação.

Para identificar eventos para uma única transação, você pode usar a combinação de lsid e txnNumber no documento de eventos do fluxo de alterações.

collectionUUID

UUID

UUID identificando a coleção onde ocorreu a alteração.

Novidades na versão 6.0.

O campo collectionUUID só é incluído se o fluxo de alteração for criado com o campo showExpandedEvents definido como true. Para obter detalhes, consulte showExpandedEvents.

documentKey

documento

Documento que contém o valor _id do documento criado ou modificado pela operação CRUD.

Para coleções fragmentadas, este campo também exibe a chave de fragmentação completa do documento. O campo _id não se repete se já fizer parte da chave fragmentada.

fullDocument

documento

O documento criado ou modificado por uma operação CRUD.

Este campo aparece somente se você configurou o fluxo de alteração com fullDocument configurado para updateLookup. Quando você configura o fluxo de alterações com updateLookup, o campo representa a versão atual confirmada pela maioria do documento modificado pela operação de atualização. O documento pode estar diferente das alterações descritas no updateDescription se outras operações confirmadas pela maioria tiverem modificado o documento entre a operação de atualização original e a pesquisa completa do documento .

Para mais informações, consulte Pesquisar documento completo para atualizar operações.

Alterado na versão 6.0.

A partir do MongoDB 6.0, se você definir a opção changeStreamPreAndPostImages usando db.createCollection(), create ou collMod, o campo fullDocument mostrará o documento depois que ele foi inserido, substituído ou atualizado (o documento pós-imagem). fullDocument é sempre incluído para eventos insert.

fullDocumentBeforeChange

documento

O documento antes das alterações serem aplicadas pela operação. Ou seja, a pré-imagem do documento.

Este campo está disponível quando você habilita o campo changeStreamPreAndPostImages para uma coleção utilizando o método db.createCollection() ou os comandos create ou collMod.

Novidades na versão 6.0.

lsid

documento

O identificador da sessão associada à transação.

Somente presente se a operação fizer parte de uma transação de vários documentos.

ns

documento

O namespace (banco de dados e/ou coleção) afetado pelo evento.

ns.coll

string

O nome da coleção onde o evento ocorreu.

ns.db

string

O nome do banco de dados onde ocorreu o evento.

operationType

string

O tipo de operação que os relatórios de notificação de alteração.

Retorna um valor de update para estes eventos de alteração.

updateDescription

documento

Um documento que descreve os campos que foram atualizados ou removidos pela operação de atualização.

updateDescription.
removedFields

array

Uma array de campos que foram removidos pela operação de atualização.

updateDescription.
truncatedArrays

array

Uma array de documentos que registram truncamentos de array executados com atualizações baseadas em pipelin usando uma ou mais das seguintes etapas:

Se toda a array for substituída, as truncações serão reportadas em updateDescription.updatedFields.

updateDescription.
truncatedArrays.
field

string

O nome do campo truncado.

updateDescription.
truncatedArrays.
newSize

inteiro

O número de elementos na array truncada.

updateDescription.
updatedFields

documento

Um documento cujas chaves correspondem aos campos que foram modificados pela operação de atualização. O valor de cada campo corresponde ao novo valor desses campos, em vez da operação que resultou no novo valor.

txnNumber

Número longo

Juntamente com o lsid, um número que ajuda a identificar exclusivamente uma transação.

Somente presente se a operação fizer parte de uma transação de vários documentos.

wallTime

Data ISO

A data e hora do servidor da operação do banco de dados. wallTime difere de clusterTime em que clusterTime é um carimbo de data/hora obtido da entrada oplog associada ao evento de operação do banco de dados.

Novidades na versão 6.0.

Comportamento

Documentar pré e pós-imagens

A partir do MongoDB 6.0, você verá um documento fullDocumentBeforeChange com os campos antes de o documento ser alterado (ou excluído) se executar estas etapas:

  1. Ative o novo campo changeStreamPreAndPostImages para uma coleção utilizando db.createCollection(), create ou collMod.

  2. Configure fullDocumentBeforeChange para "required" ou "whenAvailable" em db.collection.watch().

Exemplo de documento fullDocumentBeforeChange na saída do fluxo de mudança:

"fullDocumentBeforeChange" : {
   "_id" : ObjectId("599af247bb69cd89961c986d"),
   "userName" : "alice123",
   "name" : "Alice Smith"
}

Para obter exemplos completos com a saída do fluxo de alterações, consulte Fluxos de alterações com imagens pré e pós-documento.

As imagens pré e pós não estarão disponíveis para um change stream se as imagens forem:

  • Não habilitadas na coleção no momento de uma operação de atualização ou exclusão de documento.

  • Removido após o tempo de retenção pré e pós-imagem definido em expireAfterSeconds.

    • O exemplo a seguir define expireAfterSeconds para 100 segundos em um cluster inteiro:

      use admin
      db.runCommand( {
         setClusterParameter:
            { changeStreamOptions: {
               preAndPostImages: { expireAfterSeconds: 100 }
            } }
      } )

    • O exemplo a seguir retorna as configurações atuais do changeStreamOptions, incluindo expireAfterSeconds:

      db.adminCommand( { getClusterParameter: "changeStreamOptions" } )

    • Definir expireAfterSeconds para off usa a política de retenção: pré-imagens e pós-imagens são retidas até os eventos de change streams serem removidos do oplog.

    • Se um change stream for removido do oplog, as imagens pré e pós correspondentes também serão excluídas, independentemente do tempo de retenção pré e pós-imagem expireAfterSeconds .

Considerações adicionais:

  • Habilitar pré e pós-imagens consome espaço de armazenamento e adiciona tempo de processamento. Ative as imagens anteriores e posteriores somente se precisar delas.

  • Limite o tamanho do evento do fluxo de alterações para menos de 16 mebibytes. Para limitar o tamanho do evento, você pode:

    • Limite o tamanho do documento a 8 megabytes. Você pode solicitar imagens pré e pós simultaneamente na saída do change stream se outros campos de evento de change stream, como updateDescription não forem grandes.

    • Solicite apenas pós-imagens na saída do fluxo de alterações para documentos de até 16 mebibytes se outros campos de evento de fluxo de alterações como updateDescription não forem grandes.

    • Solicite somente pré-imagens na saída do change stream para documentos de até 16 mebibytes se:

      • as atualizações do documento afetam apenas uma pequena fração da estrutura ou conteúdo do documento, e

      • não causa um evento de alteração replace . Um evento replace sempre inclui o pós-imagem.

  • Para solicitar uma pré-imagem, defina fullDocumentBeforeChange como required ou whenAvailable em db.collection.watch(). Para solicitar uma pós-imagem, defina fullDocument usando o mesmo método.

  • As pré-imagens são escritas na coleção config.system.preimages.

    • A coleção config.system.preimages pode ficar grande. Para limitar o tamanho da coleção, você pode definir expireAfterSeconds tempo para as pré-imagens, conforme mostrado anteriormente.

    • As pré-imagens são removidas de forma assíncrona por um processo de plano de fundo.

Importante

Funcionalidade incompatível com versões anteriores

A partir do MongoDB 6.0, se você estiver usando imagens anteriores e posteriores de documentos para change streams, deverá desabilitar changeStreamPreandPostImages para cada coleção usando o collMod comando antes de poder fazer o downgrade para uma versão anterior do MongoDB.

Dica

Exemplo

O exemplo seguinte ilustra um evento update:

{
   "_id": { <Resume Token> },
   "operationType": "update",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820")
   },
   "updateDescription": {
      "updatedFields": {
         "email": "alice@10gen.com"
      },
      "removedFields": ["phoneNumber"],
      "truncatedArrays": [ {
         "field" : "vacation_time",
         "newSize" : 36
      } ]
   }
}

O exemplo seguinte ilustra um evento update para alterar fluxos abertos com a opção fullDocument : updateLookup:

{
   "_id": { <Resume Token> },
   "operationType": "update",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "documentKey": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820")
   },
   "updateDescription": {
      "updatedFields": {
         "email": "alice@10gen.com"
      },
      "removedFields": ["phoneNumber"],
      "truncatedArrays": [ {
         "field" : "vacation_time",
         "newSize" : 36
      } ]
   },
   "fullDocument": {
      "_id": ObjectId("58a4eb4a30c75625e00d2820"),
      "name": "Alice",
      "userName": "alice123",
      "email": "alice@10gen.com",
      "team": "replication"
   }
}

O documento fullDocument representa a versão mais atual acordada majoritariamente do documento atualizado. O documento fullDocument pode variar do documento no momento da operação de atualização, dependendo do número de operações de intercalação confirmadas que ocorrem entre a operação de atualização e a pesquisa do documento.

Voltar

sharedCollection

Próximo

Transações

Nesta página