MongoDB\DeleteResult::getDeletedCount()

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

• MongoDB\Driver\WriteResult::getDeletedCount()