MongoDB\Driver\WriteError
PHP Manual

MongoDB\Driver\WriteError::getIndex

Returns the index of the write operation corresponding to this WriteError

Description

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

Parameters

This function has no parameters.

Return Values

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

Errors/Exceptions

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

Examples

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

?>

The above example will output something similar to:

int(1)

See Also

  • MongoDB\Driver\BulkWrite