MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::deleteAñade una operación de eliminación al lote

Descripción

public MongoDB\Driver\BulkWrite::delete(array|object $filter, ?array $deleteOptions = null): void

Añade una operación de eliminación al 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 Defaut
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

Especificación de índice. Especifique el nombre del índice como string o el patrón de clave de índice. Si se especifica, el sistema de consulta solo considerará los planes que utilicen el índice sugerido.

Esta opción está disponible en MongoDB 4.4+ y lanzará una excepción en el momento de la ejecución si se especifica para una versión de servidor más antigua.

limit bool Elimina todos los documentos coincidentes (false), o solo el primer documento coincidente (true) false

Valores devueltos

No devuelve ningún valor.

Errores/Excepciones

Historial de cambios

Versión Descripción
PECL mongodb 1.8.0 Adición de la opción "hint".
PECL mongodb 1.2.0 Adición de la opción "collation".

Ejemplos

Ejemplo #1 Ejemplo de MongoDB\Driver\BulkWrite::delete()

<?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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top