Home/ Manual/ driver / bulkwritecommandresult/ MongoDB\Driver\BulkWriteCommandResult::getMatchedCount

MongoDB\Driver\BulkWriteCommandResult::getMatchedCount

PHP function Edit on GitHub ✎

(mongodb >=2.1.0)

Returns the number of documents selected for update

Description

MongoDB\Driver\BulkWriteCommandResult::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\BulkWriteCommandResult::getModifiedCount.

Parameters Parameters

Return Values

Returns the total number of documents selected for update by all operations.

Errors/Exceptions

Examples

MongoDB\Driver\BulkWriteCommandResult::getMatchedCount() example

php

<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand;
$bulk->insertOne('db.coll', ['x' => 1]);
$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]);
$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->deleteMany('db.coll', []);

$result = $manager->executeBulkWriteCommand($bulk);

var_dump($result->getMatchedCount());

?>

The above example will output:

output

int(1)