• API Documentation >
• Write Result Classes >
• MongoDB\DeleteResult::getDeletedCount()

MongoDB\DeleteResult::getDeletedCount()

Definition

MongoDB\DeleteResult::getDeletedCount

Return the number of documents that were deleted.

copy

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

←   MongoDB\BulkWriteResult::isAcknowledged() MongoDB\DeleteResult::isAcknowledged()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.