/ /

Update Documents

Overview

En esta guía, puedes aprender a utilizar el driver de Scala para actualizar documentos en una colección de MongoDB usando los métodos updateOne() y updateMany().

Datos de muestra

Los ejemplos de esta guía utilizan la colección restaurants en la base de datos sample_restaurants de los conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde tu aplicación Scala, crea un MongoClient que se conecte a un clúster Atlas y asigna los siguientes valores a tus variables database y collection:

val database: MongoDatabase = mongoClient.getDatabase("sample_restaurants")
val collection: MongoCollection[Document] = database.getCollection("restaurants")

Para aprender cómo crear un clúster gratuito de MongoDB Atlas y cargar los conjuntos de datos de ejemplo, consulta la guía MongoDB Get Started.

Operaciones de actualizar

Puedes actualizar documentos en MongoDB utilizando los siguientes métodos:

updateOne()que actualiza el primer documento que coincide con los criterios de búsqueda
updateMany(), que actualiza todos los documentos que coinciden con los criterios de búsqueda

Cada método de actualización requiere los siguientes parámetros:

filtro de query, que hace coincidir los documentos que deseas actualizar. Para obtener más información sobre los filtros de query, consulta la guía Especificar una query.
Actualizar documento, que especifica el operador de actualización y los campos y valores a actualizar. El operador de actualización especifica el tipo de actualización a realizar. Para ver una lista de operadores de actualización y aprender sobre sus usos, consulte la página de la guía Operadores de actualización de campos en el manual de MongoDB Server.

Ejemplo de actualización de un documento

El siguiente ejemplo utiliza el método updateOne() para actualizar el valor del campo name de un documento de "Happy Garden" a "Mountain House". El documento de actualización utiliza el método set() para actualizar el valor del campo name:

val filter = equal("name", "Happy Garden")
val update = set("name", "Mountain House")
val observable: Observable[UpdateResult] = collection.updateOne(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

Ejemplo para actualizar muchos documentos

El siguiente ejemplo usa el método updateMany() para actualizar todos los documentos en los que el valor del campo name es "Starbucks". El documento de actualización utiliza el método rename() para cambiar el nombre del campo address a location:

val filter = equal("name", "Starbucks")
val update = rename("address", "location")
val observable: Observable[UpdateResult] = collection.updateMany(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 11
Completed

Personaliza la operación de actualizar

Los métodos updateOne() y updateMany() aceptan opcionalmente un parámetro que establece opciones para configurar la operación de actualización. Si no especifica ninguna opción, el driver realizará operaciones con la configuración predeterminada.

La siguiente tabla describe los métodos setter que puedes usar para configurar una instancia de UpdateOptions:

Método	Descripción
`upsert()`	Especifica si la operación de actualización realiza una operación de inserción/actualización si ningún documento coincide con el filtro de consulta. Para obtener más información, consulte la instrucción `upsert` en el manual del servidor MongoDB. El valor predeterminado es.`false`
`sort()`	Establece los criterios de ordenación que se aplicarán a la operación. Si varios documents coinciden con el filtro de query que se pasa al método `updateOne()`, la operación actualiza el primer resultado. Puede establecer esta opción para aplicar un orden a los documents coincidentes y tener más control sobre qué document se actualiza.
`bypassDocumentValidation()`	Especifica si la operación de actualización omite la validación del documento. Esto permite actualizar documentos que no cumplen con los requisitos de validación del esquema, si los hubiera. Para obtener más información sobre la validación del esquema, consulte Validación de esquema en el manual del servidor MongoDB. El valor predeterminado `false` es.
`collation()`	Especifica el tipo de intercalación de lenguaje a usar al ordenar los resultados. Para obtener más información, consulte intercalación en el manual de MongoDB Server.
`arrayFilters()`	Proporciona una lista de filtros que indicas para seleccionar a qué elementos del arreglo se aplica la actualización.
`hint()`	Establece el índice que se utilizará al emparejar document. Para más información, consulta la instrucción de pistas en el manual de MongoDB Server.
`let()`	Proporciona un mapa de nombres y valores de parámetros para establecer variables de nivel superior para la operación. Los valores deben ser constantes o expresiones cerradas que no hagan referencia a campos del document. Para más información, consulta la instrucción let en la documentación del MongoDB Server.
`comment()`	Establece un comentario para adjuntar a la operación. Para obtener más información, consulta la guía de campos de comando de actualización en el manual del servidor de MongoDB para obtener más información.

Modificar ejemplo de actualización

Este ejemplo crea y pasa opciones al método updateOne(). El ejemplo usa el método asistente equal() para hacer coincidir documentos en los que el valor del campo name es "Sunrise Pizzeria". Luego utiliza el método set() para establecer el valor del campo borough en el primer documento coincidente a "Queens" y el valor del campo cuisine a "Italian". El código utiliza el método combine() para especificar varias actualizaciones en un único documento de actualización.

Debido a que la opción upsert está configurada en true en la instancia UpdateOptions, el controlador inserta un nuevo documento que tiene los campos y valores especificados en el filtro y en el documento de actualización si el filtro de query no coincide con ningún documento existente.

val filter = equal("name", "Sunrise Pizzeria")
val opts = UpdateOptions().upsert(true)
val update = combine(
  set("borough", "Queens"),
  set("cuisine", "Italian")
)
val observable: Observable[UpdateResult] = collection.updateOne(filter, update, opts)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

Valor de retorno

Los métodos updateOne() y updateMany() devuelven cada uno un objeto UpdateResult. Puede utilizar los siguientes métodos para acceder a la información desde una instancia de UpdateResult:

Método	Descripción
`getMatchedCount()`	Devuelve el número de document que coincidieron con el filtro de query, independientemente de cuántas actualizaciones se hayan realizado.
`getModifiedCount()`	Devuelve el número de documentos modificados por la operación de actualización. Si un document actualizado es idéntico al original, no se incluye en este recuento.
`wasAcknowledged()`	Devuelve `true` si el servidor reconoce el resultado.
`getUpsertedId()`	Devuelve el valor `_id` del document que fue inserción en la base de datos, si el driver realizó una inserción.

Nota

Si el método wasAcknowledged() retorna false, intentar acceder a otra información desde la instancia UpdateResult resulta en una excepción InvalidOperation. El driver no puede determinar estos valores si el servidor no reconoce la operación de guardado.

Información Adicional

Para ver ejemplos de código ejecutable que demuestran cómo actualizar documentos utilizando el driver de Scala, consulta Guardar datos en MongoDB.

Documentación de la API

Para aprender más sobre cualquiera de los métodos o tipos analizados en esta guía, consulta la siguiente documentación de API:

Volver

Reemplaza

Borrar