Overview
En esta guía, puedes aprender a utilizar PyMongo para remover documentos de una colección de MongoDB realizando operaciones de borrado.
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 delete_one() o los métodos delete_many().
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 un clúster gratuito de MongoDB Atlas y cargar los conjuntos de datos de muestra, consulte
Comenzar con PyMongo tutorial.
Operaciones de borrar
Puedes realizar operaciones de eliminación en MongoDB utilizando los siguientes métodos:
delete_one(), que elimina el primer documento que coincide con los criterios de búsquedadelete_many(), 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 seleccionar para eliminar. Para obtener más información sobre los filtros de query, consulte la sección Documentos de filtros de query en el manual del MongoDB Server.
Borrar un documento
El siguiente ejemplo utiliza el método delete_one() para remover un documento en la colección restaurants con un valor name de "Ready Penny Inn". Selecciona el
Synchronous o la pestaña Asynchronous para ver el código correspondiente:
query_filter = { "name": "Ready Penny Inn" } result = restaurants.delete_one(query_filter)
query_filter = { "name": "Ready Penny Inn" } result = await restaurants.delete_one(query_filter)
Borra varios documentos
El siguiente ejemplo utiliza el método delete_many() para eliminar todos los documentos de la colección restaurants con un valor borough de "Brooklyn". Seleccione la pestaña Synchronous o Asynchronous para ver el código correspondiente:
query_filter = { "borough": "Brooklyn" } result = restaurants.delete_many(query_filter)
query_filter = { "borough": "Brooklyn" } result = await restaurants.delete_many(query_filter)
Personaliza la operación de borrar
Los métodos delete_one() y delete_many() aceptan opcionalmente parámetros adicionales, que representan opciones que se pueden usar para configurar la operación de eliminación. Si no se especifican opciones adicionales, el controlador no personaliza la operación de eliminación.
Propiedad | Descripción |
|---|---|
| Specifies the kind of language collation to use when sorting
results. See Collation for more information. |
| Gets or sets the index to scan for documents.
For more information, see the hint statement
in the MongoDB Server manual. |
| An instance of ClientSession. |
| A map of parameter names and values. 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. |
| A comment to attach to the operation. For more information, see the delete command
fields guide in the
MongoDB Server manual for more information. |
El siguiente código utiliza el método delete_many() para eliminar todos los documentos en la colección restaurants que contengan un valor name que incluya la string "Mongo". También utiliza la opción comment para agregar un comentario a la operación. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:
query_filter = { 'name': {'$regex': 'Mongo' }} result = restaurants.delete_many(query_filter, comment="Deleting Mongo restaurants")
query_filter = { 'name': {'$regex': 'Mongo' }} result = await restaurants.delete_many(query_filter, comment="Deleting Mongo restaurants")
Tip
Si el ejemplo anterior usara el método delete_one() en lugar de delete_many(), el driver borraría solo el primer documento con un valor de name que incluya "Mongo".
Intercalación
Cuando realiza una operación de eliminación, puede especificar una intercalación para que la utilice el controlador.
Una intercalación es un conjunto de reglas específicas del lenguaje para la comparación de strings, como el uso de mayúsculas y minúsculas y las marcas de acento.
Para especificar una intercalación, crear una instancia de la clase Collation o un diccionario de Python. Para una lista de opciones que pueda pasar al constructor Collation o incluir como claves en el diccionario, consultar Intercalación en el manual de MongoDB Server.
Tip
Intercalación de importación
Para crear una instancia de la clase Collation, se debe importar desde pymongo.collation.
El siguiente ejemplo realiza la misma operación de borrado que el ejemplo anterior, pero con una intercalación por defecto de fr_CA. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:
from pymongo.collation import Collation query_filter = { "borough": "Brooklyn" } result = restaurants.delete_many(query_filter, collation=Collation(locale='fr_CA'))
from pymongo.collation import Collation query_filter = { "borough": "Brooklyn" } result = await restaurants.delete_many(query_filter, collation=Collation(locale='fr_CA'))
Nota
La intercalación de operaciones anula la por defecto
Cuando se especifica una intercalación como parte de una operación, esta anula la intercalación por defecto de la colección.
Valor de retorno
Los métodos delete_one() y delete_many() devuelven un tipo DeleteResult. Este tipo contiene las siguientes propiedades:
deleted_countindica la cantidad de documentos eliminadosacknowledgedque indica si el servidor reconoce el resultadoraw_result, que es el resultado sin procesar devuelto por el servidor
Nota
Si el atributo acknowledged es False, todos los demás atributos de DeleteResult arrojan una excepción InvalidOperation al ser accedidos. El driver no puede determinar estos valores si el servidor no reconoce la operación de guardado.
Si el filtro de query no coincide con ningún documento, el driver no borra ningún documento y deleted_count es 0.
Documentación de la API
Para obtener más información sobre cualquiera de los métodos o tipos discutidos en esta guía, consultar la siguiente documentación de la API: