PHP 7.4.0RC6 Released!

MongoDB\Driver\WriteResult::getDeletedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getDeletedCountReturns the number of documents deleted

Description

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

Parameters

This function has no parameters.

Return Values

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

Errors/Exceptions

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)

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top