MongoDB\Driver\WriteError::getIndex

(mongodb >=1.0.0)

MongoDB\Driver\WriteError::getIndex — Returns the index of the write operation corresponding to this WriteError

説明

final public MongoDB\Driver\WriteError::getIndex ( void ) : int

パラメータ

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

返り値

Returns the index of the write operation (from MongoDB\Driver\BulkWrite) corresponding to this WriteError.

エラー / 例外

引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。

例

例1 MongoDB\Driver\WriteError::getIndex() 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]->getIndex());
}

?>

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

int(1)

参考

MongoDB\Driver\BulkWrite