Represents an error that occurred during a bulkWrite operation (which is, generally, paginated).

Contains the number of documents that were successfully inserted, updated, deleted, etc., as well as the cumulative errors that occurred during the operation.

If the operation was ordered, the results will be in the same order as the operations that were attempted to be performed.

Field

message - A human-readable message describing the first error

Field

errorDescriptors - A list of error descriptors representing the individual errors returned by the API

Field

detailedErrorDescriptors - A list of errors 1:1 with the number of errorful API requests made to the server.

Field

partialResult - The partial result of the BulkWrite operation that was performed

Hierarchy (view full)

Constructors

Properties

detailedErrorDescriptors: DataAPIDetailedErrorDescriptor[]

A list of errors 1:1 with the number of errorful API requests made to the server. Each element contains the original command, the raw response, and the error descriptors for that request.

For operations that only make one request, this will be a singleton list (i.e. insertOne).

errorDescriptors: DataAPIErrorDescriptor[]

A list of error descriptors representing the individual errors returned by the API.

This is always equal to detailedErrorDescriptors.flatMap(d => d.errorDescriptors), for the user's convenience.

message: string

A human-readable message describing the first error.

This is always equal to errorDescriptors[0]?.message if it exists, otherwise it's given a generic default message.

name: string = 'BulkWriteError'

The name of the error. This is always 'BulkWriteError'.

partialResult: BulkWriteResult<SomeDoc>

The partial result of the BulkWrite operation that was performed. This is always defined, and is the result of all successful operations.

stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void