Home/ Manual/ driver / bulkwritecommandresult/ MongoDB\Driver\BulkWriteCommandResult::getDeleteResults

MongoDB\Driver\BulkWriteCommandResult::getDeleteResults

PHP function Edit on GitHub ✎

(mongodb >=2.1.0)

Returns verbose results for successful deletes

Description

MongoDB\Driver\BulkWriteCommandResult::getDeleteResults(): MongoDB\BSON\Document|null

Parameters Parameters

Return Values

Returns a document containing the result of each successful delete operation, or null if verbose results were not requested. The document keys will correspond to the index of the write operation from MongoDB\Driver\BulkWriteCommand.

Errors/Exceptions

Examples

MongoDB\Driver\BulkWriteCommandResult::getDeleteResults() example

php

<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand(['verboseResults' => true]);
$bulk->insertOne('db.coll', ['x' => 1]);
$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]);
$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->deleteMany('db.coll', []);

$result = $manager->executeBulkWriteCommand($bulk);

var_dump($result->getDeleteResults()->toPHP());

?>

The above example will output something similar to:

output

object(stdClass)#7 (1) {
  ["4"]=>
  object(stdClass)#6 (1) {
    ["deletedCount"]=>
    object(MongoDB\BSON\Int64)#5 (1) {
      ["integer"]=>
      string(1) "3"
    }
  }
}