Возвращает количество документов, которые сервер выбрал для обновления

# MongoDB\Driver\WriteResult::getMatchedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getMatchedCount — Возвращает количество документов, которые сервер выбрал для обновления

### Описание

final public function MongoDB\Driver\WriteResult::getMatchedCount(): int

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

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

Сигнатура функции не содержит параметров.

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

Метод возвращает количество документов, которые СУБД выбрала для обновления.

### Ошибки

- При записи без подтверждения метод выбрасывает исключение MongoDB\Driver\Exception\LogicException.
- При ошибке парсинга аргумента метод выбрасывает исключение MongoDB\Driver\Exception\InvalidArgumentException.

### Список изменений

Версия | Описание
--- | ---
PECL-модуль mongodb 2.0.0 | При вызове для записи без подтверждения метод вместо возврата значения `null` теперь выбрасывает исключение.

### Примеры

Пример #1 Пример получения количества обновляемых документов методом MongoDB\Driver\WriteResult::getMatchedCount()

    <?php

    $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->getMatchedCount());

    ?>

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

    int(1)

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

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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open