MongoDB\Driver\BulkWriteCommandResult::getDeleteResults

(mongodb >=2.1.0)

MongoDB\Driver\BulkWriteCommandResult::getDeleteResults — Returns verbose results for successful deletes

Опис

final public MongoDB\Driver\BulkWriteCommandResult::getDeleteResults(): ?MongoDB\BSON\Document

Параметри

У цієї функції немає параметрів.

Значення, що повертаються

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.

Помилки/виключення

У разі помилки обробки параметрів викидається MongoDB\Driver\Exception\InvalidArgumentException.
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() - Returns the number of documents deleted
MongoDB\Driver\BulkWriteCommandResult::isAcknowledged() - Returns whether the write was acknowledged

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.