Docs Menu
Docs Home
/
Languages
/
PHP
/
PHP Library Manual
/
API Documentation
/
Result Classes
/
DeleteResult Class

MongoDB\DeleteResult::getDeletedCount()

On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also

Definition

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.

Return Values

The number of documents that were deleted.

Errors/Exceptions

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

See Also

Back

DeleteResult Class

Next

isAcknowledged()