Home/ Manual/ driver / writeresult/ MongoDB\Driver\WriteResult::getMatchedCount

MongoDB\Driver\WriteResult::getMatchedCount

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the number of documents selected for update

Description

MongoDB\Driver\WriteResult::getMatchedCount(): int

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 Parameters

Return Values

Returns the number of documents selected for update.

Errors/Exceptions

Changelog

Version	Description

Examples

MongoDB\Driver\WriteResult::getMatchedCount() example

php

<?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:

output

int(1)