/ /

Delete Documents

Overview

En esta guía, puede aprender a usar el controlador Kotlin Sync para eliminar documentos de una colección MongoDB realizando operaciones de eliminación.

Una operación de eliminación elimina uno o más documentos de una colección de MongoDB. Puede realizar una operación de eliminación mediante el comando deleteOne() o métodos deleteMany().

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)

Operaciones de borrar

Puede realizar operaciones de eliminación en MongoDB utilizando los siguientes métodos:

deleteOne(), que elimina el primer documento que coincide con los criterios de búsqueda
deleteMany(), que elimina todos los documentos que coinciden con los criterios de búsqueda

Cada método de eliminación requiere un documento de filtro de consulta, que especifica los criterios de búsqueda que determinan qué documentos seleccionar para su eliminación. Para obtener más información sobre los filtros de consulta, consulte Especifique una guía de consulta.

Borrar un documento

El siguiente ejemplo utiliza el método deleteOne() para eliminar un documento en el que el valor del campo name es "Happy Garden":

val filter = eq(Restaurant::name.name, "Happy Garden")
val result = collection.deleteOne(filter)

Borra varios documentos

El siguiente ejemplo utiliza el método deleteMany() para eliminar todos los documentos en los que el valor del campo borough es "Brooklyn" y el valor del campo name es "Starbucks":

val filter = and(
    eq(Restaurant::borough.name, "Brooklyn"),
    eq(Restaurant::name.name, "Starbucks")
)
val result = collection.deleteMany(filter)

Personalizar la operación de eliminación

Los métodos deleteOne() y deleteMany() aceptan opcionalmente un parámetro DeleteOptions, que representa las opciones que se pueden usar para configurar la operación de eliminación. Si no se especifica ninguna opción, el controlador realiza la operación de eliminación con la configuración predeterminada.

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

Método	Descripción
`collation()`	Specifies the kind of language collation to use when sorting results. For more information, see Collation in the MongoDB Server manual.
`hint()`	Specifies the index to use when matching documents. For more information, see the hint statement in the MongoDB Server manual.
`hintString()`	Specifies the index as a string 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. For more information, see the let statement in the MongoDB Server manual.
`comment()`	Sets a comment to attach to the operation. For more information, see the delete command fields guide in the MongoDB Server manual for more information.

Modificar Eliminar Ejemplo

El siguiente código crea opciones y utiliza el método comment() para añadir un comentario a la operación de eliminación. A continuación, el ejemplo utiliza el método deleteMany() para eliminar todos los documentos de la colección restaurants cuyo valor del campo name incluya la cadena "Red".

val opts = DeleteOptions().comment("sample comment")
val filter = regex(Restaurant::name.name, "Red")
val result = collection.deleteOne(filter, opts)

Tip

Si utiliza el método deleteOne() en el ejemplo anterior en lugar del método deleteMany(), el controlador elimina solo el primer documento que coincide con el filtro de consulta.

Valor de retorno

Los métodos deleteOne() y deleteMany() devuelven cada uno una instancia DeleteResult. Puede acceder a la siguiente información desde una instancia DeleteResult:

deletedCount, que indica el número de documentos eliminados
wasAcknowledged(), que devuelve true si el servidor reconoce el resultado

Si el filtro de consulta no coincide con ningún documento, el controlador no elimina ningún documento y el valor de deletedCount es 0.

Nota

Si el método wasAcknowledged() devuelve false, al intentar acceder a la propiedad deletedCount se genera una excepción InvalidOperation. El controlador no puede determinar estos valores si el servidor no confirma la operación de escritura.

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

Reemplazar Documentos

Operaciones de escritura masiva