Edit Report a Bug

    MongoDB\Driver\BulkWrite::delete

    (mongodb >=1.0.0)

    MongoDB\Driver\BulkWrite::delete — Add a delete operation to the bulk

    Description

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

    Adds a delete operation to the MongoDB\Driver\BulkWrite.

    Liste de paramètres

    filter (array|object)

    L'» attribut de la requête. Un attribut vide va faire correspondre tous les documents de la collection.

    Note: Lors de l'évaluation des critères de requête, MongoDB compare les type et les valeurs en fonction de leur propre » règles de comparaison pour les types BSON, qui diffère des règles de comparaison et de manipulation des type de PHP. Lors de la correspondance d'un type BSON spcé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 Default
    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, reportez-vous 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 le binaire simple de comparaison utilisé 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

    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

    Valeurs de retour

    Aucune valeur n'est retournée.

    Erreurs / Exceptions

    • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.

    Historique

    Version Description
    PECL mongodb 1.8.0 Added the "hint" option.
    PECL mongodb 1.2.0 Added the "collation" option.

    Exemples

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

    ?>

    Voir aussi

    add a note add a note

    User Contributed Notes

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