MongoDB\Driver\BulkWriteCommandResult::getDeleteResults

Returns verbose results for successful deletes

説明

final public MongoDB\BSON\Documentnull MongoDB\Driver\BulkWriteCommandResult::getDeleteResults()

パラメータ

この関数にはパラメータはありません。

戻り値

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.

エラー / 例外

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Throws MongoDB\Driver\Exception\LogicException if the write was not acknowledged.

例

例1 MongoDB\Driver\BulkWriteCommandResult::getDeleteResults example

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

?>

上の例の出力は、たとえば以下のようになります。

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

参考

MongoDB\Driver\BulkWriteCommandResult::getDeletedCount
MongoDB\Driver\BulkWriteCommandResult::isAcknowledged