php8.5
Home/ Manual/ driver / bulkwritecommandresult/ MongoDB\Driver\BulkWriteCommandResult::isAcknowledged

MongoDB\Driver\BulkWriteCommandResult::isAcknowledged

PHP function Edit on GitHub ✎

(mongodb >=2.1.0)

Returns whether the write was acknowledged

Description

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

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

Parameters Parameters

Return Values

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

Errors/Exceptions

Examples

MongoDB\Driver\BulkWriteCommandResult::isAcknowledged() with acknowledged write concern

php
<?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());

?>

The above example will output:

output
bool(true)

MongoDB\Driver\BulkWriteCommandResult::isAcknowledged() with unacknowledged write concern

php
<?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());

?>

The above example will output:

output
bool(false)

See Also

  • MongoDB\Driver\WriteConcern
  • Write Concern reference

Source: reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml · from the official PHP manual (php/doc-en)