MongoDB\Driver\WriteConcernError::getMessage

(mongodb >=1.0.0)

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

説明

final public function MongoDB\Driver\WriteConcernError::getMessage(): string

パラメータ

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

戻り値

Returns the WriteConcernError's error message.

エラー / 例外

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

例

例1 MongoDB\Driver\WriteConcernError::getMessage() example

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

?>

上の例の出力は、たとえば以下のようになります。

string(33) "waiting for replication timed out"

参考

» Write Concern reference

関連キーワード:

MongoDB Driver WriteConcernError getMessage error message example bulk writeConcern mongodb Exception manager getInfo WriteError final Throws InvalidArgumentException argument parsing errors Manager replicaSet myReplicaSet BulkWrite insert WriteConcern