php8.5
Home/ Manual/ driver / writeconcernerror/ MongoDB\Driver\WriteConcernError::getMessage

MongoDB\Driver\WriteConcernError::getMessage

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the WriteConcernError's error message

Description

MongoDB\Driver\WriteConcernError::getMessage(): string

Parameters Parameters

Return Values

Returns the WriteConcernError's error message.

Errors/Exceptions

Examples

MongoDB\Driver\WriteConcernError::getMessage() example

php
<?php

$manager = new MongoDB\Driver\Manager("mongodb://rs1.example.com,rs2.example.com/?replicaSet=myReplicaSet");

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

$writeConcern = new MongoDB\Driver\WriteConcern(2, 1);

try {
    $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]);
} catch(MongoDB\Driver\Exception\BulkWriteException $e) {
    var_dump($e->getWriteResult()->getWriteConcernError()->getMessage());
}

?>

The above example will output something similar to:

output
string(33) "waiting for replication timed out"

See Also

  • Write Concern reference

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