MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::deleteAdd a delete operation to the bulk

Опис

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

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

Параметри

filter (array|object)

» Предикат запиту. Порожній предикат відповідає всім документам у колекції.

Зауваження: Під час виконання критеріїв запиту MongoDB порівнює типи та значення за власними » правилами порівняння BSON-типів, що відрізняється від правил порівняння і перетворення типів в PHP. Для вибірки даних спеціальних BSON-типів, критерії запиту повинні використовувати відповідний клас BSON (напр. MongoDB\BSON\ObjectId для вибірки » ObjectId).

deleteOptions

deleteOptions
Option Type Description Default
collation array|object

» Зіставлення дозволяє вказувати специфічні для мови правила порівняння рядків, як от правила регістру та знаків наголосу. Під час визначення зіставлень поле "locale" є обов'язковим, а всі інші поля — ні. Опис полів є на сторінці » Документ зіставлення.

Якщо зіставлення не вказано, то використовується стандартне зіставлення для колекції, якщо воно вказано. Якщо ж ні, MongoDB використовує просте двійкове порівняння, яке використовувалося в попередніх версіях для порівняння рядків.

Цей параметр доступний у MongoDB 3.4+, тож його застосування у старіших версіях викине виключення під час виконання.

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

Значення, що повертаються

Не повертає значень.

Помилки/виключення

Журнал змін

Версія Опис
PECL mongodb 1.8.0 Added the "hint" option.
PECL mongodb 1.2.0 Added the "collation" option.

Приклади

Приклад #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);

?>

Прогляньте також

add a note

User Contributed Notes

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