/ /

Delete Documents

Overview

En esta guía, puede aprender a utilizar la biblioteca PHP de MongoDB 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 MongoDB\Collection::deleteOne() o los métodos MongoDB\Collection::deleteMany().

Datos de muestra

Los ejemplos de esta guía usan la colección restaurants en la base de datos sample_restaurants de la Conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde tu aplicación PHP, instancie un MongoDB\Client que se conecte a un clúster de Atlas y asigne el siguiente valor a tu variable $collection:

$collection = $client->sample_restaurants->restaurants;

Para saber cómo crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de ejemplo, consulta la guía MongoDB Primeros Pasos.

Operaciones de borrar

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

MongoDB\Collection::deleteOne(), que elimina el primer documento que coincide con los criterios de búsqueda
MongoDB\Collection::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 para determinar qué documentos seleccionar para su eliminación. Para obtener más información sobre los filtros de consulta, consulte la sección "Documentos de filtro de consulta" en el manual de MongoDB Server.

Borrar un documento

El siguiente ejemplo usa el método deleteOne() para remover un documento en la colección restaurants que tiene un valor name de 'Ready Penny Inn':

$collection->deleteOne(['name' => 'Ready Penny Inn']);

Borra varios documentos

El siguiente ejemplo utiliza el método deleteMany() para remover todos los documentos en la colección restaurants que tienen un valor borough de 'Brooklyn':

$collection->deleteMany(['borough' => 'Brooklyn']);

Modificar la operación de eliminación

Puedes modificar el comportamiento de los métodos MongoDB\Collection::deleteOne() y MongoDB\Collection::deleteMany() pasando un arreglo que especifique los valores de opciones como parámetro. La siguiente tabla describe las opciones que puedes establecer en el arreglo:

Opción	Descripción
`collation`	Specifies the kind of language collation to use when comparing strings. To learn more, see the Collation section of this page.
`writeConcern`	Sets the write concern for the operation. This option defaults to the collection's write concern. For more information, see Write Concern in the MongoDB Server manual.
`hint`	Gets or sets the index to scan for documents. For more information, see the hint statement in the MongoDB Server manual.
`let`	Specifies a document with a list of values to improve operation readability. 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.
`session`	Specifies the client session to associate with the operation. For more information, see Session in the MongoDB Server manual.
`comment`	Attaches a comment to the operation. For more information, see the delete command fields guide in the MongoDB Server manual.

Intercalación

Para especificar una intercalación para tu operación, pasa un parámetro arreglo $options que establezca la opción collation en el método de la operación. Asigna la opción collation a un arreglo que configure las reglas de intercalación.

La siguiente tabla describe los campos que se pueden configurar para la intercalación:

Campo	Descripción
`locale`	(Required) Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server manual. Data Type: `string`
`caseLevel`	(Optional) Specifies whether to include case comparison. When set to `true`, the comparison behavior depends on the value of the `strength` field: - If `strength` is `1`, the PHP library compares base characters and case. - If `strength` is `2`, the PHP library compares base characters, diacritics, other secondary differences, and case. - If `strength` is any other value, this field is ignored. When set to `false`, the PHP library doesn't include case comparison at strength level `1` or `2`. Data Type: `bool` Default: `false`
`caseFirst`	(Optional) Specifies the sort order of case differences during tertiary level comparisons. Data Type: `string` Default: `"off"`
`strength`	(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. Data Type: `int` Default: `3`
`numericOrdering`	(Optional) Specifies whether the driver compares numeric strings as numbers. If set to `true`, the PHP library compares numeric strings as numbers. For example, when comparing the strings "10" and "2", the library uses the strings' numeric values and treats "10" as greater than "2". If set to `false`, the PHP library compares numeric strings as strings. For example, when comparing the strings "10" and "2", the library compares one character at a time and treats "10" as less than "2". For more information, see Collation Restrictions in the MongoDB Server manual. Data Type: `bool` Default: `false`
`alternate`	(Optional) Specifies whether the library considers whitespace and punctuation as base characters for comparison purposes. Data Type: `string` Default: `"non-ignorable"`
`maxVariable`	(Optional) Specifies which characters the library considers ignorable when the `alternate` field is set to `"shifted"`. Data Type: `string` Default: `"punct"`
`backwards`	(Optional) Specifies whether strings containing diacritics sort from the back of the string to the front. Data Type: `bool` Default: `false`

Para obtener más información sobre la intercalación y los posibles valores de cada campo, consulta la entrada Collation en el manual del servidor de MongoDB.

Ejemplo

El siguiente ejemplo llama al método deleteMany() para borrar todos los documentos en la colección restaurants que tengan un valor name que contenga la string 'Mongo'. También establece la opción comment en un parámetro de arreglo para añadir un comentario a la operación:

$collection->deleteMany(
    ['name' => new MongoDB\BSON\Regex('Mongo')],
    ['comment' => 'Deleting Mongo restaurants'],
);

Nota

Si sustituyes el método deleteMany() por deleteOne() en el ejemplo anterior, la librería borra sólo el primer documento que tiene un valor name que contiene 'Mongo'.

Valor de retorno

Los métodos MongoDB\Collection::deleteOne() y MongoDB\Collection::deleteMany() devuelven un objeto MongoDB\DeleteResult. Esta clase contiene las siguientes funciones miembro:

isAcknowledged(), que devuelve un valor booleano que indica si se reconoció la operación.
getDeletedCount(), que devuelve el número de documentos eliminados. Si no se confirmó la operación de escritura, este método genera un error.

Si el filtro de query no coincide con ningún documentos, el driver no borra ningún documentos y getDeletedCount() devuelve 0.

Ejemplo

El siguiente ejemplo llama al método deleteMany() para eliminar documentos que tienen un valor de cuisine de 'Greek'. Luego, llama a la función nodo getDeletedCount() para imprimir el número de documentos eliminados:

$result = $collection->deleteMany(['cuisine' => 'Greek']);
echo 'Deleted documents: ', $result->getDeletedCount(), PHP_EOL;

Deleted documents: 111

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