array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'class.mongodb-driver-writeerror.php', 1 => 'MongoDB\\Driver\\WriteError', 2 => 'The MongoDB\\Driver\\WriteError class', ), 'up' => array ( 0 => 'mongodb.mongodb.php', 1 => 'MongoDB\\Driver', ), 'prev' => array ( 0 => 'mongodb-driver-writeconcernerror.getmessage.php', 1 => 'MongoDB\\Driver\\WriteConcernError::getMessage', ), 'next' => array ( 0 => 'mongodb-driver-writeerror.getcode.php', 1 => 'MongoDB\\Driver\\WriteError::getCode', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mongodb/mongodb/driver/writeerror.xml', ), 'history' => array ( ), 'extra_header_links' => array ( 'rel' => 'alternate', 'href' => '/manual/en/feeds/class.mongodb-driver-writeerror.atom', 'type' => 'application/atom+xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

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().

Class synopsis

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 getCode(): int
final public getIndex(): int
final public getInfo(): ?object
final public getMessage(): string
}

Properties

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.

Changelog

Version Description
PECL mongodb 2.3.0 Added public readonly properties.

Table of Contents