PHP 8.5.0 Alpha 2 available for testing

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 » atributo de la consulta. Un atributo vacío hará coincidir todos los documentos de la colección.

Nota: Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias » reglas de comparación para los tipos BSON, que difieren de las reglas de comparación y de manipulación de tipos de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON (ej. : utilizar MongoDB\BSON\ObjectId para hacer coincidir un » ObjectId).

deleteOptions

deleteOptions
Option Type Description Defaut
collation array|object

» Collation permite a los usuarios especificar reglas específicas del lenguaje para la comparación de cadenas, por ejemplo, reglas para mayúsculas o acentos. Al especificar una collation, el campo "locale" es obligatorio; todos los demás campos de la collation son opcionales. Para la descripción de estos campos, consúltese el » documento Collation.

Si la collation no es especificada pero la colección tiene una collation por omisión, la operación utilizará la collation especificada para la colección. Si ninguna collation es especificada para la colección o para la operación, MongoDB utilizará el binario simple de comparación utilizado en versiones anteriores para las comparaciones de cadenas.

Esta opción está disponible en MongoDB 3.4+ y una excepción será emitida en tiempo de ejecución si es especificada en una versión anterior.

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 se retorna ningún valor.

Errores/Excepciones

  • Lanza una excepción MongoDB\Driver\InvalidArgumentException en caso de error durante el análisis de un argumento.

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