/ /

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 eliminación utilizando los métodos deleteOne() o deleteMany().

Datos de muestra

Los ejemplos de esta guía usan la colección sample_restaurants.restaurants de los conjuntos de datos de muestra de Atlas. Para aprender cómo crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de muestra, consulta la guía MongoDB Comenzar.

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 coincida con los criterios de búsqueda
deleteMany(), que borra todos los documentos que cumplen 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 seleccionar para su eliminación. Para obtener más información sobre los filtros de query, consulta 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()`	Especifica el tipo de intercalación de lenguaje a usar al ordenar los resultados. Para obtener más información, consulte intercalación en el manual de MongoDB Server.
`hint()`	Especifica el índice que se utilizará para la búsqueda de documentos. Para obtener más información, consulte la instrucción de sugerencia en el manual del servidor MongoDB.
`hintString()`	Especifica el índice como una cadena de texto que se utilizará para la búsqueda de documentos. Para obtener más información, consulte la instrucción de sugerencia en el manual del servidor MongoDB.
`let()`	Proporciona un mapa de nombres y valores de parámetros para establecer variables de nivel superior para la operación. Los valores deben ser constantes o expresiones cerradas que no hagan referencia a campos del document. Para más información, consulta la instrucción let en la documentación del MongoDB Server.
`comment()`	Establece un comentario para adjuntar a la operación. Para obtener más información, consulta la guía de campos del comando de eliminación en el manual del servidor MongoDB.

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 se utiliza el método deleteOne() en el ejemplo anterior en lugar del método deleteMany(), el driver borrará solo el primer documento que coincida con el filtro de query.

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, intentar acceder a la propiedad deletedCount resulta en una excepción InvalidOperation. El driver no puede determinar estos valores si el servidor no reconoce la operación de guardado.

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