MongoDB\BulkWriteResult::getMatchedCount()

MongoDB\BulkWriteResult::getMatchedCount()

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

MongoDB\BulkWriteResult::getMatchedCount()

Definition

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().](https://www.mongodb.com/docs/php-library/current/reference/method/mongodbbulkwriteresult-getmodifiedcount.md#mongodb-phpmethod-phpmethod.MongoDB-BulkWriteResult--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](https://www.mongodb.com/docs/php-library/current/reference/exception-classes.md#mongodb-phpclass-phpclass.MongoDB-Exception-BadMethodCallException if this method is called and the write operation used an unacknowledged write concern.

agentengine secret delete

MongoDB\BulkWriteResult::getMatchedCount()