Reemplazar Documentos

Overview

En esta guía, puedes aprender cómo usar el controlador de Kotlin para reemplazar documentos en una colección de MongoDB. Una operación de reemplazo utiliza un filtro de query para buscar un documento en una colección, luego reemplaza el documento con uno nuevo.

Reemplazar un documento

La El métodoreplaceOne() elimina todos los campos y valores existentes en el documento coincidente (excepto el _id campo) e inserta los campos y valores del documento de reemplazo.

Puedes llamar al método replaceOne() en una instancia de MongoCollection de la siguiente manera:

collection.replaceOne(<query>, <replacementDocument>)

Si varios documentos coinciden con el filtro de query especificado en el método replaceOne(), la operación reemplaza el primer resultado. Puede especificar un orden en una instancia de ReplaceOptions para aplicar un orden a los documentos coincidentes antes de que el controlador ejecute la operación de reemplazo, como se muestra en el siguiente código:

val opts = ReplaceOptions().sort(Sorts.ascending(PaintOrder::color.name))

Si ningún documento coincide con el filtro de query en la operación de reemplazo, replaceOne() no realiza cambios en los documentos de la colección. Ver el Inserción guía para aprender a insertar un nuevo documento en lugar de reemplazar uno si no se encuentra ningún documento coincidente.

After applying the update, the (immutable) field '_id' was found to have been altered to _id: ObjectId('...)

E11000 duplicate key error collection: ...

Reemplazar un ejemplo

Una tienda de pinturas vende cinco colores diferentes de pintura. Los documentos de la siguiente colección representan los colores de pintura en el inventario de la tienda:

{ "_id": 1, "color": "red", "qty": 5 }
{ "_id": 2, "color": "purple", "qty": 8 }
{ "_id": 3, "color": "yellow", "qty": 0 }
{ "_id": 4, "color": "green", "qty": 6 }
{ "_id": 5, "color": "pink", "qty": 20 }

La siguiente clase de datos de Kotlin modela estos datos:

data class PaintOrder(
    @BsonId val id: Int,
    val color: String,
    val qty: Int
)

La tienda de pinturas debe actualizar su inventario para reemplazar 20 latas de pintura rosa con 25 latas de pintura naranja.

Para actualizar el inventario, llama al método replaceOne():

val filter = Filters.eq(PaintOrder::color.name, "pink")
val update = PaintOrder(5, "orange", 25)
val result = collection.replaceOne(filter, update)
println("Matched document count: $result.matchedCount")
println("Modified document count: $result.modifiedCount")

  Matched document count: 1
  Modified document count: 1

La operación de reemplazo anterior crea el siguiente documento:

 { "_id": 5, "color": "orange", "qty": 25 }

Ejemplo avanzado de sustituir uno

En el siguiente ejemplo, el método replaceOne() reemplaza la primera coincidencia del filtro de query en la colección movies del conjunto de datos Atlas sample_mflix.movies con un documento de reemplazo. La operación elimina todos los campos, excepto _id, del documento original e inserta los campos del documento de reemplazo. La siguiente Movie clase de datos modela los documentos de esta colección para su uso con el controlador de Kotlin:

data class Movie(
    val title: String,
    val year: Int,
    val genres: List<String>,
    val rated: String,
    val plot: String,
    val runtime: Int,
    val imdb: IMDB,
    val fullplot: String? = "No full plot",
){
    data class IMDB(
        val rating: Double
    )
}

Antes de que se ejecute la operación replaceOne(), el documento original contiene varios campos que describen la película. Después de que se ejecute la operación, el documento resultante contiene solo los campos especificados por el documento de reemplazo (title y fullplot) y el campo _id.

El siguiente ejemplo utiliza los siguientes objetos y métodos:

• Un filtro de consulta que se pasa al replaceOne() método. El eq filtro solo encuentra películas cuyo título coincida exactamente con el "Music of the Heart" texto.

• Un documento de reemplazo que contiene el documento que sustituye al documento correspondiente, si existe.

• Un objeto de ReplaceOptions con la opción upsert establecida en true. Esta opción especifica que el método inserta los datos contenidos en el documento de reemplazo si el filtro de query no coincide con ningún documento.

import com.mongodb.MongoException
import com.mongodb.client.model.Filters
import com.mongodb.client.model.ReplaceOptions
import com.mongodb.kotlin.client.coroutine.MongoClient
import kotlinx.coroutines.runBlocking
data class Movie(val title: String, val fullplot: String)
fun main() = runBlocking {
    // Replace the uri string with your MongoDB deployment's connection string
    val uri = "<connection string uri>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    val collection = database.getCollection<Movie>("movies")
    try {
        val query = Filters.eq("title", "Music of the Heart")
        val replaceDocument = Movie( "50 Violins", " A dramatization of the true story of Roberta Guaspari who co-founded the Opus 118 Harlem School of Music")
        val options = ReplaceOptions().upsert(true)
        val result = collection.replaceOne(query, replaceDocument, options)
        println("Modified document count: " + result.modifiedCount)
        println("Upserted id: " + result.upsertedId) // only contains a non-null value when an upsert is performed
    } catch (e: MongoException) {
        System.err.println("Unable to replace due to an error: $e")
    }
    mongoClient.close()
}

El ejemplo anterior devuelve el siguiente resultado:

Modified document count: 1
Upserted id: null

Si el ejemplo anterior resultó en una inserción, el código devuelve la siguiente salida:

Modified document count: 0
Upserted id: BsonObjectId{value=...}

Si consulta el documento reemplazado, la consulta devuelve el siguiente resultado:

Movie(title=50 Violins, fullplot= A dramatization of the true story of Roberta Guaspari
who co-founded the Opus 118 Harlem School of Music)

Información Adicional

Para obtener más información sobre los métodos y clases utilizados en esta página, consulte la siguiente documentación de API:

• Reemplace uno

• ReplaceOptions

• UpdateResult

• eq()