php8.5
Home/ Manual/ driver / writeerror/ MongoDB\Driver\WriteError::getIndex

MongoDB\Driver\WriteError::getIndex

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the index of the write operation corresponding to this WriteError

Description

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

Parameters Parameters

Return Values

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

Errors/Exceptions

Examples

MongoDB\Driver\WriteError::getIndex() example

php
<?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:

output
int(1)

See Also

  • MongoDB\Driver\BulkWrite

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