php8.5
Home/ Manual/ driver / writeresult/ MongoDB\Driver\WriteResult::isAcknowledged

MongoDB\Driver\WriteResult::isAcknowledged

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns whether the write was acknowledged

Description

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

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

Parameters Parameters

Return Values

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

Errors/Exceptions

Examples

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

php
<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);

$result = $manager->executeBulkWrite('db.collection', $bulk);

var_dump($result->isAcknowledged());

?>

The above example will output:

output
bool(true)

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

php
<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);

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

$result = $manager->executeBulkWrite('db.collection', $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/writeresult/isacknowledged.xml · from the official PHP manual (php/doc-en)