MongoDB\Driver\WriteResult::getInsertedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getInsertedCount — Returns the number of documents inserted (excluding upserts)

説明

final public int|null MongoDB\Driver\WriteResult::getInsertedCount ( void )

パラメータ

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

返り値

Returns the number of documents inserted (excluding upserts), or NULL if the write was not acknowledged.

エラー / 例外

引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。

例

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

?>

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

int(1)

参考

MongoDB\Driver\WriteResult::isAcknowledged() - Returns whether the write was acknowledged