MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::delete — Додавання операції видалення порції

Опис

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

Додає операцію видалення в об'єкт MongoDB\Driver\BulkWrite

Список параметрів

filter(array|object)

» Предикат запиту. Порожній предикат збігатиметься з усіма елементами колекції.

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

deleteOptions

deleteOptions

Опция	Тип	Опис	Значение по умолчанию
collation	array	object
» Зіставлення дозволяє користувачам вказувати специфічні для конкретної мови правила для порівняння рядків, такі як реакцію на регістр літер та надрядкові знаки. Якщо поставлено зіставлення, то поле `"locale"`также обязательно. Опис полей смотрите в разделе» Зіставлення

Якщо зіставлення не задано явно, але в колекції визначено зіставлення за умовчанням, буде використано воно. Якщо немає ні того, то MongoDB буде використовувати просте бінарне порівняння рядків.

Ця опція доступна у MongoDB 3.4+ і, якщо буде використана для більш старих версій, викличе виняток під час виконання.

Індекс специфікації. Вкажіть або назву індексу у вигляді рядка, або шаблон ключа індексу. Якщо зазначено, система запитів розглядатиме плани лише з використанням індексу підказок.

Опція доступна з MongoDB 4.4+ і призведе до виключення під час виконання, якщо вона вказана для старої версії сервера.

| | limit | bool | Удалить все подходящие документа (false) або тільки перший знайдений документ (true false

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

Функція не повертає значення після виконання.

Помилки

При помилці парсингу аргумент кидає винятокMongoDB\Driver\Exception\InvalidArgumentException

список змін

Версия	Опис
PECL mongodb 1.8.0	Добавлена опция`"hint"`
PECL mongodb 1.2.0	Добавлена опция`"collation"`

Приклади

Приклад #1 Приклад використання MongoDB\Driver\BulkWrite::delete()****

Loading...

Дивіться також

MongoDB\Driver\Manager::executeBulkWrite() - Виконує одну або кілька операцій запису
MongoDB\Driver\WriteResult