Overview
En esta guía, puede aprender a supervisar los cambios en los documentos mediante un flujo de cambios.
Un flujo de cambios genera nuevos eventos de cambio, lo que proporciona acceso a cambios de datos en tiempo real. Puede abrir un flujo de cambios en una colección, una base de datos o un objeto cliente.
Datos de muestra
Los ejemplos de esta guía utilizan lo siguiente: Course Estructura como modelo para los documentos de la colección courses:
type Course struct { Title string Enrollment int32 }
Para ejecutar los ejemplos de esta guía, cargue estos documentos en la colección courses de la base de datos db utilizando el siguiente fragmento:
coll := client.Database("db").Collection("courses") docs := []interface{}{ Course{Title: "World Fiction", Enrollment: 35}, Course{Title: "Abstract Algebra", Enrollment: 60}, } result, err := coll.InsertMany(context.TODO(), docs)
Tip
Bases de datos y colecciones inexistentes
Si la base de datos y la colección necesarias no existen cuando realiza una operación de escritura, el servidor las crea implícitamente.
Cada documento contiene una descripción de un curso universitario que incluye el título del curso y la matrícula máxima, correspondiente a los campos title y enrollment de cada documento.
Nota
Cada salida de ejemplo muestra valores _data, clusterTime y ObjectID truncados porque el controlador los genera de forma única.
Abre un flujo de cambios
Para abrir un flujo de cambios, use el método Watch(). El método Watch() requiere un parámetro de contexto y un parámetro de canalización. Para devolver todos los cambios, pase un objeto Pipeline vacío.
Ejemplo
El siguiente ejemplo abre un flujo de cambios en la colección courses y genera todos los cambios:
changeStream, err := coll.Watch(context.TODO(), mongo.Pipeline{}) if err != nil { panic(err) } defer changeStream.Close(context.TODO()) // Iterates over the cursor to print the change stream events for changeStream.Next(context.TODO()) { fmt.Println(changeStream.Current) }
Si modifica la colección courses en un programa o shell independiente, este código imprime los cambios a medida que se producen. Insertar un documento con un valor title de "Advanced Screenwriting" y un valor enrollment de 20 genera el siguiente evento de cambio:
map[_id:map[_data:...] clusterTime: {...} documentKey:map[_id:ObjectID("...")] fullDocument:map[_id:ObjectID("...") enrollment:20 title:Advanced Screenwriting] ns: map[coll:courses db:db] operationType:insert]
Modificar la salida del flujo de cambios
Utilice el parámetro pipeline para modificar la salida del flujo de cambios. Este parámetro le permite observar únicamente ciertos eventos de cambio. Formatee el parámetro pipeline como una matriz de documentos, donde cada documento representa una etapa de agregación.
Puede utilizar las siguientes etapas de canalización en este parámetro:
$addFields$match$project$replaceRoot$replaceWith$redact$set$unset
Ejemplo
El siguiente ejemplo abre un flujo de cambios en la base de datos db pero solo observa nuevas operaciones de eliminación:
db := client.Database("db") pipeline := bson.D{{"$match", bson.D{{"operationType", "delete"}}}} changeStream, err := db.Watch(context.TODO(), mongo.Pipeline{pipeline}) if err != nil { panic(err) } defer changeStream.Close(context.TODO()) // Iterates over the cursor to print the delete operation change events for changeStream.Next(context.TODO()) { fmt.Println(changeStream.Current) }
Nota
Se llamó al método Watch() en la base de datos db, por lo que el código genera nuevas operaciones de eliminación en cualquier colección dentro de esta base de datos.
Modificar el comportamiento de Watch()
Utilice el parámetro options para modificar el comportamiento del método Watch().
Puede especificar las siguientes opciones para el método Watch():
ResumeAfterStartAfterFullDocumentFullDocumentBeforeChangeBatchSizeMaxAwaitTimeCollationStartAtOperationTimeCommentShowExpandedEventsStartAtOperationTimeCustomCustomPipeline
Para obtener más información sobre estas opciones, visite el Manual del servidor MongoDB.
Imágenes pre y post
Al realizar una operación CRUD en una colección, el documento de evento de cambio correspondiente contiene, por defecto, solo la diferencia de los campos modificados por la operación. Puede ver el documento completo antes y después de un cambio, además de la diferencia, especificando la configuración en el parámetro options del método Watch().
Si desea ver la imagen posterior de un documento, la versión completa del documento después de un cambio, establezca el campo FullDocument del parámetro options en uno de los siguientes valores:
UpdateLookup:El documento de evento de cambio incluye una copia de todo el documento modificado.WhenAvailable:El documento de evento de cambio incluye una imagen posterior del documento modificado para eventos de cambio si la imagen posterior está disponible.Required:La salida es la misma que paraWhenAvailable, pero el controlador genera un error del lado del servidor si la imagen posterior no está disponible.
Si desea ver la imagen previa de un documento, la versión completa del documento antes de un cambio, establezca el campo FullDocumentBeforeChange del parámetro options en uno de los siguientes valores:
WhenAvailable:El documento de evento de cambio incluye una imagen previa del documento modificado para eventos de cambio si la imagen previa está disponible.Required:La salida es la misma que paraWhenAvailable, pero el controlador genera un error del lado del servidor si la imagen previa no está disponible.
Importante
Para acceder a las imágenes previas y posteriores del documento, debe habilitar changeStreamPreAndPostImages en la colección.Consulte el manual del servidor MongoDB para obtener instrucciones y más información.
Nota
No existe una imagen previa para un documento insertado ni una imagen posterior para un documento eliminado.
Ejemplo
El siguiente ejemplo llama al método Watch() en la colección courses. Especifica un valor para el campo FullDocument del parámetro options para generar una copia de todo el documento modificado, en lugar de solo los campos modificados:
opts := options.ChangeStream().SetFullDocument(options.UpdateLookup) changeStream, err := coll.Watch(context.TODO(), mongo.Pipeline{}, opts) if err != nil { panic(err) } defer changeStream.Close(context.TODO()) for changeStream.Next(context.TODO()) { fmt.Println(changeStream.Current) }
Actualizar el valor enrollment del documento con el title de "World Fiction" de 35 a 30 da como resultado el siguiente evento de cambio:
{"_id": {"_data": "..."},"operationType": "update","clusterTime": {"$timestamp": {"t":"...","i":"..."}},"fullDocument": {"_id": {"$oid":"..."},"title": "World Fiction","enrollment": {"$numberInt":"30"}}, "ns": {"db": "db","coll": "courses"},"documentKey": {"_id": {"$oid":"..."}}, "updateDescription": {"updatedFields": {"enrollment": {"$numberInt":"30"}}, "removedFields": [],"truncatedArrays": []}}
Sin especificar la opción FullDocument, la misma operación de actualización ya no genera el valor "fullDocument" en el documento del evento de cambio.
Información Adicional
Para ver un ejemplo ejecutable de un flujo de cambios, consulte Abrir un ejemplo de flujo de cambios.
Para obtener más información sobre los flujos de cambio, consulte Flujos de cambio.
Documentación de la API
Para obtener más información sobre el método Watch(), visite los siguientes enlaces de documentación de API: