MongoDB\Driver\WriteError::getMessage

(mongodb >=1.0.0)

MongoDB\Driver\WriteError::getMessage — Returns the WriteError's error message

Description

final public MongoDB\Driver\WriteError::getMessage(): string

Parameters

This function has no parameters.

Return Values

Returns the WriteError's error message.

Errors/Exceptions

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

Examples

Example #1 MongoDB\Driver\WriteError::getMessage() example


<?php

$manager = new MongoDB\Driver\Manager;

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

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

?>

The above example will output something similar to:

string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }"