MongoDB\Driver\BulkWrite::delete
(mongodb >=1.0.0)
MongoDB\Driver\BulkWrite::delete — Add a delete operation to the bulk
Descripción
Adds a delete operation to the MongoDB\Driver\BulkWrite.
Parámetros
-
filter(array|object) -
El » predicado de la consulta. Un predicado vacío coincidirá con todos los documentos de una colección.
Nota: Al evaluar criterios de consulta, MongoDB compara tipos y valores según sus propias » reglas de comparación para tipos BSON, lo cual difiere de las reglas de comparación y manejo de tipos de PHP. Al encontrar un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON respectiva (p.ej. usar MongoDB\BSON\ObjectID al encontrar un » ObjectID).
-
deleteOptions -
deleteOptions Option Type Description Default collation array|object » Collation, o cotejamiento, permite a los usuarios especificar reglas específcas del lenguaje para comparar cadenas, tales como reglas para mayúsculas/minúsculas y marcas de acento. Cuando se especifica el cotejamiento, el cambpo
"locale"es obligatorio; todos los demás campos de cotejamiento son opcionales. Para la descripción de los campos, véase la » Documentación de Collation.Si no se especifica el cotejamiento y la colección tiene un cotejamiento predeterminado, la operación usará el cotejamiento especificado por la colección. Si no se especifica el cotejamiento para la colección o para la operación, MongoDB usará la comparación binaria simple utilizada en versiones anteriores para comparar cadenas.
Esta opción está disponible en MongoDB 3.4+ y resultará en una excepción durante la ejecución si se especifica para una versión más antigua del servidor.
hint string|array|object Index specification. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index.
This option is available in MongoDB 4.4+ and will result in an exception at execution time if specified for an older server version.
limit bool Delete all matching documents ( false), or only the first matching document (true)false
Valores devueltos
No devuelve ningún valor.
Errores/Excepciones
- Lanza una MongoDB\Driver\Exception\InvalidArgumentException en errores de análisis de argumentos.
Historial de cambios
| Versión | Descripción |
|---|---|
| PECL mongodb 1.8.0 |
Added the "hint" option.
|
| PECL mongodb 1.2.0 |
Added the "collation" option.
|
Ejemplos
Ejemplo #1 MongoDB\Driver\BulkWrite::delete() example
<?php
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->delete(['x' => 1], ['limit' => 1]);
$bulk->delete(['x' => 2], ['limit' => 0]);
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$result = $manager->executeBulkWrite('db.collection', $bulk);
?>Ver también
- MongoDB\Driver\Manager::executeBulkWrite() - Execute one or more write operations
- MongoDB\Driver\WriteResult
add a note
