Docs Menu
Docs Home
/ / /
PHP Library Manual
/ / /

MongoDB\DeleteResult::getDeletedCount()

On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also
MongoDB\DeleteResult::getDeletedCount()

Return the number of documents that were deleted.

function getDeletedCount(): integer

This method should only be called if the write was acknowledged.

The number of documents that were deleted.

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

Back

DeleteResult Class