MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

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

Описание

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

Добавляет операцию удаления в объект MongoDB\Driver\BulkWrite.

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

filter (array|object)

» Предикат запроса. Пустой предикат совпадёт со всеми элементами коллекции.

Замечание: СУБД MongoDB при оценке критериев запроса сравнивает типы и значения по внутренним » правилам сравнения BSON-типов, которые не совпадают с правилами сравнения и жонглирования типами в PHP. При сопоставлении специального BSON-типа в запросе требуется передать объект BSON-класса, который соответствует типу BSON-значения, поэтому для сопоставления с BSON-типом » ObjectId указывают объект класса MongoDB\BSON\ObjectId.

deleteOptions

**deleteOptions**
Опция	Тип	Описание	Значение по умолчанию
collation	array\|object	» Сопоставление позволяет пользователям указывать специфичные для конкретного языка правила для сравнения строк, такие как реакцию на регистр букв и надстрочные знаки. Если задали сопоставление, то поле `"locale"` также обязательно. Описание полей смотрите в разделе » Сопоставление. Если сопоставление не задали явно, но у коллекции определили сопоставление по умолчанию, то будет выбрано оно. Если нет ни того ни того, то MongoDB будет использовать простое бинарное сравнение строк. Эта опция доступна в MongoDB 3.4+ и, если будет использована для более старых версий, вызовет исключение во время исполнения.
hint	string\|array\|object	Индекс спецификации. Укажите либо имя индекса в виде строки, либо шаблон ключа индекса. Если указано, то система запросов будет рассматривать планы только с использованием индекса подсказок. Опция доступна с 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()

<?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);

?>

Смотрите также

MongoDB\Driver\Manager::executeBulkWrite() - Выполняет операции записи
MongoDB\Driver\WriteResult

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы