The MongoDB\Driver\Exception\BulkWriteCommandException class

Introduction

Exception thrown due to failed execution of a MongoDB\Driver\BulkWriteCommand. The methods of this class provide more details of the error that occurred, including the error reply and partial results from the bulk write.

Class synopsis

MongoDB\Driver\Exception\BulkWriteCommandException
class MongoDB\Driver\Exception\BulkWriteCommandException extends MongoDB\Driver\Exception\ServerException implements MongoDB\Driver\Exception\Exception {
/* Properties */
private MongoDB\BSON\Documentnull $errorReply;
private MongoDB\Driver\BulkWriteCommandResultnull $partialResult;
private array $writeConcernErrors;
private array $writeErrors;
/* Inherited properties */
protected arraynull $errorLabels;
protected string $message = "";
private string $string = "";
protected int $code;
protected string $file = "";
protected int $line;
private array $trace = [];
private Throwablenull $previous = null;
/* Methods */
final public MongoDB\BSON\Documentnull getErrorReply()
final public MongoDB\Driver\BulkWriteCommandResultnull getPartialResult()
final public array getWriteConcernErrors()
final public array getWriteErrors()
/* Inherited methods */
final public bool MongoDB\Driver\Exception\RuntimeException::hasErrorLabel(string $errorLabel)
final public string Exception::getMessage()
final public Throwablenull Exception::getPrevious()
final public int Exception::getCode()
final public string Exception::getFile()
final public int Exception::getLine()
final public array Exception::getTrace()
final public string Exception::getTraceAsString()
public string Exception::__toString()
private void Exception::__clone()
}

Properties

errorReply

Any top-level error that occurred when attempting to communicate with the server or execute the bulk write. This value may be null if the exception was thrown due to errors occurring on individual writes.

partialResult

A MongoDB\Driver\BulkWriteCommandResult reporting the result of any successful operations that were performed before the error was encountered. This value may be null if it cannot be determined that at least one write was successfully performed (and acknowledged).

writeConcernErrors

An array of any MongoDB\Driver\WriteConcernErrors that occurred while executing the bulk write. This list may have multiple items if more than one server command was required to execute the bulk write.

writeErrors

An array of any MongoDB\Driver\WriteErrors that occurred during the execution of individual write operations. Array keys will correspond to the index of the write operation from MongoDB\Driver\BulkWriteCommand. This map will contain at most one entry if the bulk write was ordered.

Table of Contents