/ /

Escritura de datos

Docs Home

Librerías de clientes

Scala

Escritura de datos

Docs Home

Librerías de clientes

Scala

Escritura de datos

Reemplazar Documentos

Overview

En esta guía, puedes aprender a usar el driver de Scala para realizar una operación de reemplazo en un documento de una colección de MongoDB. Una operación de reemplazo remueve todos los campos y valores de un documento especificado excepto el _id campo y agrega los nuevos campos y valores que especifique. Esta operación difiere de una operación de actualización, que solo modifica los campos especificados en uno o más documentos.

Para obtener más información sobre las operaciones de actualización, consulta el Actualizar Documentos guía.

Datos de muestra

Los ejemplos de esta guía usan la colección restaurants en la base de datos sample_restaurants de la Conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde tu aplicación Scala, crea un objeto 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.

Operación de reemplazo

Puede realizar una operación de reemplazo en MongoDB con el método replaceOne(). Este método elimina todos los campos excepto el campo _id del primer documento que coincida con el filtro de consulta especificado. A continuación, añade los campos y valores especificados al documento vacío.

Parámetros necesarios

Debes pasar los siguientes parámetros al método replaceOne():

Filtro de query, que se utiliza para determinar qué documentos se actualizarán. Para obtener más información sobre los filtros de query, consulta la guía Especificar una query.
Documento de reemplazo, que especifica los campos y valores que deseas reemplazar con los campos y valores existentes.

Reemplazar un documento

El siguiente ejemplo utiliza el método replaceOne() para reemplazar los campos y valores de un documento en el que el valor del campo name es "Primola Restaurant":

val filter = equal("name", "Primola Restaurant")
val replacement = Document(
  "name" -> "Frutti Di Mare",
  "borough" -> "Queens",
  "cuisine" -> "Seafood",
  "owner" -> "Sal Thomas"
)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

Importante

El valor del campo _id es inmutable. Si el documento de reemplazo especifica un valor para el campo _id, debe ser igual al valor _id del documento existente; de lo contrario, el controlador generará un error WriteError.

Personalizar la operación de reemplazo

El método replaceOne() acepta opcionalmente un parámetro con el tipo de dato ReplaceOptions. La clase ReplaceOptions contiene métodos setters que se pueden utilizar para configurar la opción de reemplazo. Si no especifica ninguna opción, el driver realiza la operación de reemplazo con la configuración por defecto.

La siguiente tabla describe los métodos setter en la clase ReplaceOptions:

Método	Descripción
`upsert()`	Specifies whether the replace operation performs an upsert operation if no documents match the query filter. For more information, see upsert behavior in the MongoDB Server manual. Defaults to `false`.
`sort()`	Sets the sort criteria to apply to the operation. If multiple documents match the query filter that you pass to the `replaceOne()` method, the operation replaces the first result. You can set this option to apply an order to matched documents to have more control over which document is replaced.
`bypassDocumentValidation()`	Specifies whether the update operation bypasses document validation. This lets you update documents that don't meet the schema validation requirements, if any exist. For more information about schema validation, see Schema Validation in the MongoDB Server manual. Defaults to `false`.
`collation()`	Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
`hint()`	Sets the index to use when matching documents. For more information, see the hint statement in the MongoDB Server manual.
`let()`	Provides a map of parameter names and values to set top-level variables for the operation. Values must be constant or closed expressions that don't reference document fields.
`comment()`	Sets a comment to attach to the operation.

El siguiente código establece la opción upsert en true, lo que indica al driver que inserte un nuevo documento con los campos y valores especificados en el documento de reemplazo si el filtro de query no coincide con ningún documento existente:

val options = ReplaceOptions().upsert(true)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement, options)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

Valor de retorno

El método replaceOne() retorna un objeto UpdateResult. Puedes usar los siguientes métodos para acceder a la información de una instancia de UpdateResult:

Método	Descripción
`getMatchedCount()`	Returns the number of documents that matched the query filter.
`getModifiedCount()`	Returns the number of documents modified by the update operation. If an updated document is identical to the original, it is not included in this count.
`wasAcknowledged()`	Returns `true` if the server acknowledged the result.
`getUpsertedId()`	Returns the `_id` value of the document that the driver upserted into the database, if any.

Información Adicional

Para ver un ejemplo de código ejecutable que demuestra cómo reemplazar un documento, consulte Escribir 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

Insert

Update