/ /

Delete Documents

Overview

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

Una operación de borrado remueve uno o más documentos de una colección de MongoDB. Puedes realizar una operación de borrar usando el deleteOne() o los métodos deleteMany().

Datos de muestra

Los ejemplos en esta guía utilizan la colección sample_restaurants.restaurants de la conjuntos de datos de muestra de Atlas. Para aprender a crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de ejemplo, consulta la guía de MongoDB Get Started.

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

data class Restaurant(val name: String, val borough: String)

Operaciones de borrar

Puedes 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 query, que especifica los criterios de búsqueda que determinan qué documentos se seleccionarán para su eliminación. Para aprender más sobre los filtros de query, consulte la Guía 'Especificar una query' .

Borrar un documento

El siguiente ejemplo utiliza el método deleteOne() para remover 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 remover todos los documentos en los que el valor del campo borough sea "Brooklyn" y el valor del campo name sea "Starbucks":

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

Personaliza la operación de borrar

Los métodos deleteOne() y deleteMany() aceptan opcionalmente un parámetro DeleteOptions, que representa opciones que puedes usar para configurar la operación de borrar. Si no especificas ninguna opción, el driver realiza la operación de borrado con la configuración por defecto.

La siguiente tabla describe los métodos de establecimiento que puedes utilizar para configurar una instancia de 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 Borrar Ejemplo

El siguiente código crea opciones y usa el método comment() para agregar un comentario a la operación de eliminación. Luego, el ejemplo utiliza el método deleteMany() para borrar todos los documentos en la colección restaurants en los que el valor del campo name incluye el string "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 de DeleteResult. Puedes acceder a la siguiente información desde una instancia de DeleteResult:

deletedCountindica la cantidad de documentos eliminados
wasAcknowledged()lo que retorna true si el servidor reconoce el resultado

Si el filtro de query no coincide con ningún documento, el driver 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