Class MongoBulkWriteError

An error indicating an unsuccessful Bulk Write

Hierarchy (view full)

Constructors

constructor

Properties

cause? code? codeName? connectionGeneration? err? errInfo? errorResponse message ok? result stack? topologyVersion? writeConcernError? writeErrors prepareStackTrace? stackTraceLimit

Accessors

deletedCount errmsg errorLabels insertedCount insertedIds matchedCount modifiedCount name upsertedCount upsertedIds

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

Properties

Optionalcause

cause?: Error

Optionalcode

code?: string | number

This is a number in MongoServerError and a string in MongoDriverError

OptionalcodeName

codeName?: string

OptionalconnectionGeneration

connectionGeneration?: number

Optionalerr

err?: WriteConcernError

OptionalerrInfo

errInfo?: Document

errorResponse

errorResponse: ErrorDescription

Raw error result document returned by server.

message

message: string

Optionalok

ok?: number

result

result: BulkWriteResult

Optionalstack

stack?: string

OptionaltopologyVersion

topologyVersion?: TopologyVersion

OptionalwriteConcernError

writeConcernError?: Document

writeErrors

writeErrors: OneOrMore<WriteError> = []

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Accessors

deletedCount

errmsg

  • get errmsg(): string

  • Legacy name for server error responses

    Returns string

errorLabels

  • get errorLabels(): string[]

  • Returns string[]

insertedCount

insertedIds

  • get insertedIds(): {
        [key: number]: any;
    }

  • Inserted document generated Id's, hash key is the index of the originating operation

    Returns {
        [key: number]: any;
    }

    • [key: number]: any

matchedCount

  • get matchedCount(): number

  • Number of documents matched for update.

    Returns number

modifiedCount

name

upsertedCount

upsertedIds

  • get upsertedIds(): {
        [key: number]: any;
    }

  • Upserted document generated Id's, hash key is the index of the originating operation

    Returns {
        [key: number]: any;
    }

    • [key: number]: any

Methods

addErrorLabel

hasErrorLabel

  • hasErrorLabel(label): boolean

  • Checks the error to see if it has an error label

    Parameters

    • label: string

      The error label to check for

    Returns boolean

    returns true if the error has the provided error label

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods