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

MongoDB\BulkWriteResult::getDeletedCount()

Definition

MongoDB\BulkWriteResult::getDeletedCount

Return the total number of documents that were deleted by all delete operations in the bulk write.

copy

function getDeletedCount(): integer

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

Return Values

The total number of documents that were deleted by all delete operations in the bulk write.

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

←   Write Result Classes MongoDB\BulkWriteResult::getInsertedCount()  →

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