MongoDB\BulkWriteResult::getMatchedCount()
On this page
Definition
MongoDB\BulkWriteResult::getMatchedCount()Return the total number of documents that were matched by all update and replace operations in the bulk write.
function getMatchedCount(): integer This method should only be called if the write was acknowledged.
Note
If an update/replace 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
getModifiedCount().
Return Values
The total number of documents that were matched by all update and replace operations in the bulk write.
Errors/Exceptions
MongoDB\Exception\BadMethodCallException if this method is
called and the write operation used an unacknowledged write concern.