PHP マニュアル: Returns the number of documents selected for update

説明

final public int MongoDB\Driver\WriteResult::getMatchedCount()

If the update operation results in no change to the document (e.g. setting the value of a field to its current value), the matched count may be greater than the value returned by MongoDB\Driver\WriteResult::getModifiedCount.

パラメータ

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

戻り値

Returns the number of documents selected for update.

エラー / 例外

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

変更履歴

バージョン	説明
PECL mongodb 2.0.0	This method now throws an exception when called for an unacknowledged write instead of returning `null`.

例

例1 MongoDB\Driver\WriteResult::getMatchedCount 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->getMatchedCount());

?>

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

int(1)

参考

MongoDB\Driver\WriteResult::getModifiedCount
MongoDB\Driver\WriteResult::isAcknowledged