MongoDB\Driver\WriteResult::getMatchedCount

Returns the number of documents selected for update

&reftitle.description; final public ``int``null```MongoDB\Driver\WriteResult::getMatchedCount`

If the update operation results in no change to the document (e.g. setting the value of a field to its current value), the matched count may be greater than the value returned by `MongoDB\Driver\WriteResult::getModifiedCount`.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

Returns the number of documents selected for update, or &null; if the write was not acknowledged.

&reftitle.errors;

&mongodb.throws.argumentparsing;

&reftitle.examples;

### `MongoDB\Driver\WriteResult::getMatchedCount` example

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

    ?>

&example.outputs;

    int(1)

&reftitle.seealso;

- `MongoDB\Driver\WriteResult::getModifiedCount`
- `MongoDB\Driver\WriteResult::isAcknowledged`