Docs Menu

Docs HomePHP Library Manual

MongoDB\UpdateResult::getMatchedCount()

On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also
MongoDB\\UpdateResult::getMatchedCount()

Return the number of documents that were matched.

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().

The number of documents that were matched.

MongoDB\\Exception\\BadMethodCallException if this method is called and the write operation used an unacknowledged write concern.

←  MongoDB\InsertOneResult::isAcknowledged()MongoDB\UpdateResult::getModifiedCount() →