MongoDB\Driver\BulkWriteCommandResult::isAcknowledged

Returns whether the write was acknowledged

説明

final public bool MongoDB\Driver\BulkWriteCommandResult::isAcknowledged()

If the write is acknowledged, other fields will be available on the MongoDB\Driver\BulkWriteCommandResult object.

パラメータ

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

戻り値

Returns true if the write was acknowledged, and false otherwise.

エラー / 例外

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

例1 MongoDB\Driver\BulkWriteCommandResult::isAcknowledged with acknowledged write concern

<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand;
$bulk->insertOne('db.coll', ['x' => 1]);

$result = $manager->executeBulkWriteCommand($bulk);

var_dump($result->isAcknowledged());

?>

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

bool(true)

例2 MongoDB\Driver\BulkWriteCommandResult::isAcknowledged with unacknowledged write concern

<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand(['ordered' => false]);
$bulk->insertOne('db.coll', ['x' => 1]);

$writeConcern = new MongoDB\Driver\WriteConcern(0);

$result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]);

var_dump($result->isAcknowledged());

?>

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

bool(false)

参考