/ /

Reemplazar Documentos

Overview

En esta guía, aprenderá a usar el controlador de sincronización de Kotlin para reemplazar un documento de una colección de MongoDB. Una operación de reemplazo elimina todos los campos y valores de un documento específico, excepto... _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, consulte la Guía deactualización de documentos.

Datos de muestra

Los ejemplos de esta guía utilizan la colección sample_restaurants.restaurants de Conjuntos de datos de muestra de Atlas. Para aprender a crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de muestra, consulte la guía de introducción a MongoDB.

Los documentos de esta colección están modelados por la siguiente clase de datos de Kotlin:

data class Restaurant(
    val name: String,
    val borough: String,
    val cuisine: String,
    val owner: String?,
)

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 coincide con el filtro de consulta. A continuación, añade los campos y valores especificados al documento vacío.

Parámetros requeridos

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

Filtro deconsulta que identifica los documentos que se actualizarán. Para obtener más información sobre los filtros de consulta, consulte la guía "Especificar una consulta".
Documento de reemplazo, que especifica los campos y valores con los que desea reemplazar 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 = Filters.eq(Restaurant::name.name, "Primola Restaurant")
val replacement = Restaurant(
    "Frutti Di Mare",
    "Queens",
    "Seafood",
    owner = "Sal Thomas"
)
val result = collection.replaceOne(filter, replacement)

Importante

Los valores de los campos _id son inmutables. 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 que define opciones para configurar la operación de reemplazo. Si no se especifica ninguna opción, el controlador realiza la operación de reemplazo con la configuración predeterminada.

La siguiente tabla describe los métodos de configuración que puede utilizar para configurar una instancia ReplaceOptions:

Propiedad	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(Bson 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 controlador que inserte un nuevo documento que tenga los campos y valores especificados en el documento de reemplazo si el filtro de consulta no coincide con ningún documento existente:

val opts = ReplaceOptions().upsert(true)
val result = collection.replaceOne(filter, replacement, opts)

Valor de retorno

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

Propiedad	Descripción
`getMatchedCount()`	Returns the number of documents that matched the query filter, regardless of how many updates were performed.
`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 was upserted in the database, if the driver performed an upsert.

Información Adicional

Para ver un ejemplo de código ejecutable que demuestra cómo reemplazar un documento, consulte Insertar documentos.

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

Update Documents

Delete Documents