MongoDB\Driver\WriteResult::getDeletedCount

Returns the number of documents deleted

Description

final public int|null MongoDB\Driver\WriteResult::getDeletedCount ( void )

Parameters

This function has no parameters.

Return Values

Returns the number of documents deleted, or NULL if the write was not acknowledged.

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Examples

Example #1 MongoDB\Driver\WriteResult::getDeletedCount example


<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->update(['x' => 1], ['$set' => ['y' => 3]]);
$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->delete(['x' => 1]);

$result = $manager->executeBulkWrite('db.collection', $bulk);

var_dump($result->getDeletedCount());

?>

The above example will output:

int(1)