Docs Menu
Docs Home
/ /

replace Evento

replace

Un evento replace ocurre cuando una operación de actualización elimina un documento de una colección y lo reemplaza con un documento nuevo, como cuando replaceOne Se llama al método.

Campo
Tipo
Descripción

_id

Documento

Un objeto BSON que sirve como identificador del evento del flujo de cambios. Este valor se utiliza como resumeToken para el resumeAfter parámetro al reanudar un flujo de cambios. Los campos del _id objeto dependen de las versiones de MongoDB y, en algunos casos, de la versión de compatibilidad de características (FCV) vigente al momento de la apertura o reanudación del flujo de cambios.

Para ver un ejemplo de cómo reanudar un flujo de cambios resumeToken por, consulte Reanudar un flujo de cambios.

clusterTime

Marca de tiempo

clusterTime es la marca de tiempo de la entrada del registro de operaciones asociada con el evento.

Debido a los límites de tamaño del registro de operaciones, lastransacciones multidocumento pueden crear varias entradas del registro de operaciones. En una transacción, los eventos de flujo de cambios almacenados en una entrada del registro de operaciones comparten el clusterTime mismo.

Es posible que no todos los eventos con el mismo clusterTime se relacionen con la misma transacción. Algunos eventos no se relacionan con ninguna transacción. A partir de MongoDB 8.0, esto puede ocurrir con eventos en cualquier implementación. En versiones anteriores, este comportamiento solo era posible con eventos en un clúster fragmentado.

Para identificar eventos para una sola transacción, puede utilizar la combinación de lsid y txnNumber en el documento de evento de flujo de cambios.

Cambiado en la versión 8.0.

collectionUUID

UUID

UUID que identifica la colección donde ocurrió el cambio.

Novedades en la versión 6.0.

El campo collectionUUID solo se incluye si el flujo de cambios se crea con el campo showExpandedEvents establecido en true. Para obtener más información, consulte mostrarEventosExpandidos.

documentKey

Documento

Documento que contiene el _id valor del documento creado o modificado por la operación CRUD.

En las colecciones fragmentadas, este campo también muestra la clave de fragmento completa del documento. El campo _id no se repite si ya forma parte de la clave de fragmento.

fullDocument

Documento

El nuevo documento creado por la operación.

Cambiado en la versión 6.0.

A partir de MongoDB,6.0 si configura la changeStreamPreAndPostImages opción usando, o, entonces db.createCollection() create collModel fullDocument campo muestra el documento después de que fue insertado, reemplazado o actualizado (la imagen posterior del documento). fullDocument siempre se incluye para insert los eventos.

fullDocumentBeforeChange

Documento

El documento antes de que la operación aplicara los cambios. Es decir, la preimagen del documento.

Este campo está disponible cuando habilita el changeStreamPreAndPostImages campo para una colección utilizando db.createCollection() el método o los comandos create collMod o.

Novedades en la versión 6.0.

lsid

Documento

El identificador de la sesión asociada con la transacción.

Sólo está presente si la operación es parte de una transacción de múltiples documentos.

ns

Documento

El espacio de nombres (base de datos y/o colección) afectado por el evento.

ns.coll

string

El nombre de la colección donde ocurrió el evento.

ns.db

string

El nombre de la base de datos donde ocurrió el evento.

operationType

string

El tipo de operación que informa la notificación de cambio.

Devuelve un valor de replace para estos eventos de cambio.

txnNumber

Número largo

Junto con el lsid, un número que ayuda a identificar de forma única una transacción.

Sólo está presente si la operación es parte de una transacción de múltiples documentos.

wallTime

La fecha y hora del servidor de la operación de la base de datos. wallTime se diferencia de clusterTime en que clusterTime es una marca de tiempo tomada de la entrada del registro de operaciones asociada con el evento de operación de la base de datos.

Novedades en la versión 6.0.

A partir de MongoDB 6.0, verá un documento fullDocumentBeforeChange con los campos anteriores a que se cambiara (o eliminara) el documento si realiza estos pasos:

  1. Habilite el nuevo changeStreamPreAndPostImages campo para una colección usando,db.createCollection() create collModo.

  2. Establezca fullDocumentBeforeChange "required" "whenAvailable" db.collection.watch()en o en.

Ejemplo de documento fullDocumentBeforeChange en la salida del flujo de cambios:

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

Para obtener ejemplos completos con la salida del flujo de cambios, consulta Flujos de cambio con imágenes previas y posteriores de documentos.

Las imágenes previas y posteriores no están disponibles para un evento de flujo de cambios si las imágenes fueron:

  • No está habilitado en la colección en el momento de la operación de actualización o eliminación de un documento.

  • Eliminado después del tiempo de retención de imágenes previas y posteriores establecido en expireAfterSeconds.

    • El siguiente ejemplo configura expireAfterSeconds en 100 segundos en todo el clúster:

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

      Nota

      El comando setClusterParameter no es compatible con los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulta Comandos no compatibles en Atlas.

    • El siguiente ejemplo devuelve la configuración actual de changeStreamOptions, incluyendo expireAfterSeconds:

      db.adminCommand( { getClusterParameter: "changeStreamOptions" } )
    • Configurar expireAfterSeconds en off utiliza la política de retención por defecto: las imágenes previas y posteriores se conservan hasta que los eventos correspondientes del flujo de cambios se eliminan del oplog.

    • Si se elimina un evento de flujo de cambios del oplog, las imágenes previas y posteriores correspondientes también se eliminan independientemente del tiempo de retención de las imágenes previas y posteriores expireAfterSeconds.

Consideraciones adicionales:

  • Habilitar las imágenes previas y posteriores consume espacio de almacenamiento y aumenta el tiempo de procesamiento. Habilita solo las imágenes previas y de publicación si las necesitas.

  • Limita el tamaño del evento del flujo de cambios a menos de 16 mebibytes. Para limitar el tamaño del evento, puedes:

    • Limita el tamaño del documento a 8 megabytes. Puedes solicitar imágenes previas y posteriores simultáneamente en la salida del flujo de cambios si otros campos de eventos del flujo de cambios como updateDescription no son grandes.

    • Solicita solo imágenes posteriores en la salida del flujo de cambios para documentos de hasta 16 mebibytes si otros campos de eventos del flujo de cambios como updateDescription no son grandes.

    • Solicita solo imágenes previas en la salida del flujo de cambios para documentos de hasta 16 mebibytes si:

      • las actualizaciones de documento afectan solo a una pequeña fracción de la estructura o el contenido del documento, y

      • no cause un evento de cambio replace. Un evento replace siempre incluye la imagen de publicación.

  • Para realizar una solicitud de imagen previa, debes establecer fullDocumentBeforeChange en required o whenAvailable en db.collection.watch(). Para solicitar una imagen posterior, establece fullDocument mediante el mismo método.

  • Las imágenes previas se escriben en la colección config.system.preimages.

    • La colección config.system.preimages puede agrandarse. Para limitar el tamaño de la colección, puedes establecer el tiempo a expireAfterSeconds para las imágenes previas como se mostró antes.

    • Las imágenes previas se eliminan de forma asincrónica mediante un proceso en segundo plano.

Importante

Característica incompatible con versiones anteriores

A partir de MongoDB 6.0, si utilizas imágenes previas y posteriores de documentos para los flujos de cambios, debes deshabilitar changeStreamPreAndPostImages para cada colección mediante el comando collMod antes de poder volver a una versión anterior de MongoDB.

Tip

El comando puede producir update update diferentes eventos de cambio (no solo) dependiendo de los cambios reales que realice en la colección.

Evento de cambio
Descripción

La operación de actualización modificó un documento existente.

La operación de actualización reemplazó el documento o produjo una diferencia que era más detallada que el documento original, lo que provocó que MongoDB lo reemplazara.

La operación de actualización intentó actualizar un documento inexistente y, en su lugar, lo agregó a la colección. Esto solo ocurre cuando la actualización se ejecuta con la opción upsert habilitada.

El siguiente ejemplo ilustra un evento replace:

{
"_id": { <Resume Token> },
"operationType": "replace",
"clusterTime": <Timestamp>,
"wallTime": <ISODate>,
"ns": {
"db": "engineering",
"coll": "users"
},
"documentKey": {
"_id": ObjectId("599af247bb69cd89961c986d")
},
"fullDocument": {
"_id": ObjectId("599af247bb69cd89961c986d"),
"userName": "alice123",
"name": "Alice"
}
}

Una operación replace utiliza el comando de actualización y consta de dos etapas:

  • Eliminar el documento original con documentKey y

  • Inserte el nuevo documento utilizando el mismo documentKey

El fullDocument de un evento replace representa el documento después de la inserción del documento de reemplazo.

Volver

renombrar

En esta página