MongoDB\Driver\BulkWriteCommandResult::getDeletedCount

(mongodb >=2.1.0)

MongoDB\Driver\BulkWriteCommandResult::getDeletedCount — Returns the number of documents deleted

説明

final public function MongoDB\Driver\BulkWriteCommandResult::getDeletedCount(): int

パラメータ

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

戻り値

Returns the total number of documents deleted by all operations.

エラー / 例外

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

例

例1 MongoDB\Driver\BulkWriteCommandResult::getDeletedCount() example

<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand;
$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->getDeletedCount());

?>

上の例の出力は以下となります。

int(3)

参考

MongoDB\Driver\BulkWriteCommandResult::getDeleteResults() - Returns verbose results for successful deletes
MongoDB\Driver\BulkWriteCommandResult::isAcknowledged() - Returns whether the write was acknowledged

関連キーワード:

MongoDB Driver BulkWriteCommandResult bulk getDeletedCount coll number documents deleted updateOne getDeleteResults Throws Exception write acknowledged manager upsert mongodb final total operations InvalidArgumentException argument parsing errors