The MongoDB\Driver\WriteError class

(mongodb >=1.0.0)

Introduction

The MongoDB\Driver\WriteError class encapsulates information about a write error and may be returned as an array element from MongoDB\Driver\WriteResult::getWriteErrors().

final class MongoDB\Driver\WriteError {

/* Properties */

public readonly string $message;

public readonly int $code;

public readonly int $index;

public readonly ?object $info;

/* Methods */

final public function getCode(): int

final public function getIndex(): int

final public function getInfo(): ?object

final public function getMessage(): string

}

message: The error message.
code: The error code.
index: The index of the write operation within the MongoDB\Driver\BulkWrite that caused the error.
info: Additional information for the error, or null if not available.

Version	Description
PECL mongodb 2.3.0	Added public readonly properties.

MongoDB\Driver\WriteError::getCode — Returns the WriteError's error code
MongoDB\Driver\WriteError::getIndex — Returns the index of the write operation corresponding to this WriteError
MongoDB\Driver\WriteError::getInfo — Returns metadata document for the WriteError
MongoDB\Driver\WriteError::getMessage — Returns the WriteError's error message

There are no user contributed notes for this page.