PHP Manual: Returns the number of documents selected for update

Description

final public int 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.

Parameters

This function has no parameters.

Return Values

Returns the number of documents selected for update.

Errors/Exceptions

Throws MongoDB\Driver\Exception\LogicException if the write was not acknowledged.
Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Changelog

Version	Description
PECL mongodb 2.0.0	This method now throws an exception when called for an unacknowledged write instead of returning `null`.

Examples

Example #1 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());

?>

The above example will output:

int(1)

MongoDB\Driver\WriteResult::getMatchedCount