- Reference >
- Write Result Classes >
- MongoDB\BulkWriteResult::getModifiedCount()
MongoDB\BulkWriteResult::getModifiedCount()
On this page
Definition
-
MongoDB\BulkWriteResult::getModifiedCount
Return the total number of documents that were modified by all update and replace operations in the bulk write.
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 modified count may be less than the value returned by
getMatchedCount()
.
Return Values
The total number of documents that were modified by all update and replace operations in the bulk write.
The modified count is not available on versions of MongoDB before 2.6, which
used the legacy wire protocol version (i.e. OP_UPDATE
). If this is the case,
the modified count will be null
.
Errors/Exceptions
MongoDB\Exception\BadMethodCallException
if this method is
called and the write operation used an unacknowledged write concern.