MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::delete — Ajoute une opération de suppression au lot

Description

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

Ajoute une opération de suppression au MongoDB\Driver\BulkWrite.

Liste de paramètres

filter (array|object)

Le » prédicat de la requête. Un prédicat vide va faire correspondre tous les documents de la collection.

Note:

Lors de l'évaluation des critères de requête, MongoDB compare les types et les valeurs en fonction de ses propres » règles de comparaison pour les types BSON, qui diffèrent des règles de comparaison et de manipulation des types de PHP. Lors de la correspondance d'un type BSON spécial, les critères de requête doivent utiliser la classe BSON (ex. : utiliser MongoDB\BSON\ObjectId pour correspondre à un » ObjectId).

deleteOptions

deleteOptions
Option Type Description Défaut
collation array|object » Collation permet aux utilisateurs de spécifier des règles spécifiques au langage pour la comparaison des chaînes, par exemple, des règles pour les majuscules ou les accents. Lors de la spécification d'une collation, le champ "locale" est obligatoire ; tous les autres champs de la collation sont optionnels. Pour la description de ces champs, se reporter au » document Collation. Si la collation n'est pas spécifiée mais que la collection a une collation par défaut, l'opération utilisera la collation spécifiée pour la collection. Si aucune collation n'est spécifiée pour la collection ou pour l'opération, MongoDB utilisera la comparaison binaire simple utilisée dans les versions précédentes pour les comparaisons des chaînes. Cette option est disponible en MongoDB 3.4+ et une exception sera émise au moment de l'exécution si elle est spécifiée dans une version antérieure.
hint string|array|object Spécification d'index. Spécifiez soit le nom de l'index en tant que chaîne soit le modèle de clé d'index. Si spécifié, le système de requête ne considérera que les plans utilisant l'index suggéré. Cette option est disponible dans MongoDB 4.4+ et entraînera une exception au moment de l'exécution si elle est spécifiée pour une version de serveur plus ancienne.
limit bool Supprime tous les documents correspondants (false), ou seulement le premier document correspondant (true) false

Valeurs de retour

Aucune valeur n'est retournée.

Erreurs / Exceptions

Historique

Version Description
PECL mongodb 1.8.0 Ajout de l'option "hint".
PECL mongodb 1.2.0 Ajout de l'option "collation".

Exemples

Exemple #1 Exemple 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);

?>

Voir aussi