MongoDB\Driver\WriteResult::getModifiedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getModifiedCount — Возвращает количество существующих обновлённых документов

Описание

final public MongoDB\Driver\WriteResult::getModifiedCount(): ?int

Если операция обновления не приводит к изменению документа (например, установка значения поля в его текущее значение), изменённое число может быть меньше, чем значение, возвращаемое MongoDB\Driver\WriteResult::getMatchedCount().

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

У этой функции нет параметров.

Возвращаемые значения

Возвращает количество существующих обновлённых документов или null, если запись не была подтверждена.

Изменённый счётчик недоступен в версиях MongoDB до версии 2.6, в которой использовалась устаревшая версия проводного протокола (т.е. OP_UPDATE). В этом случае изменённое количество также будет равно null.

Ошибки

• При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.

Примеры

Пример #1 Пример использования MongoDB\Driver\WriteResult::getModifiedCount()

$manager = new MongoDB\Driver\Manager;
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->update(['x' => 1], ['$set' => ['y' => 3]]);
$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->delete(['x' => 1]);
$result = $manager->executeBulkWrite('db.collection', $bulk);
var_dump($result->getModifiedCount());

Результат выполнения данного примера:

int(1)

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

• MongoDB\Driver\WriteResult::getMatchedCount() - Возвращает количество документов, выбранных для обновления
• MongoDB\Driver\WriteResult::isAcknowledged() - Возвращает, была ли запись подтверждена

User Contributed Notes

There are no user contributed notes for this page.

Описание на ru2.php.net
Описание на php.ru