MongoDB\Driver\BulkWriteCommandResult
PHP Manual

MongoDB\Driver\BulkWriteCommandResult::getMatchedCount

Returns the number of documents selected for update

Description

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

Parameters

This function has no parameters.

Return Values

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

Errors/Exceptions

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

Examples

Example #1 MongoDB\Driver\BulkWriteCommandResult::getMatchedCount example

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

int(1)

See Also

  • MongoDB\Driver\BulkWriteCommandResult::getModifiedCount
  • MongoDB\Driver\BulkWriteCommandResult::getUpdateResults
  • MongoDB\Driver\BulkWriteCommandResult::isAcknowledged