Class MongoBulkWriteError

An error indicating an unsuccessful Bulk Write

Hierarchy

Constructors

constructor

Properties

cause? code? codeName? connectionGeneration? err? errInfo? 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

Optional cause

cause?: Error

Optional code

code?: string | number

This is a number in MongoServerError and a string in MongoDriverError

Optional codeName

codeName?: string

Optional connectionGeneration

connectionGeneration?: number

Optional err

err?: WriteConcernError

Optional errInfo

errInfo?: mongoose.mongo.BSON.Document

message

message: string

Optional ok

ok?: number

result

result: BulkWriteResult

Optional stack

stack?: string

Optional topologyVersion

topologyVersion?: TopologyVersion

Optional writeConcernError

writeConcernError?: mongoose.mongo.BSON.Document

writeErrors

writeErrors: OneOrMore<WriteError>

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

deletedCount

  • get deletedCount(): number

  • Number of documents deleted.

    Returns number

errmsg

  • get errmsg(): string

  • Legacy name for server error responses

    Returns string

errorLabels

  • get errorLabels(): string[]

  • Returns string[]

insertedCount

  • get insertedCount(): number

  • Number of documents inserted.

    Returns number

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

  • get modifiedCount(): number

  • Number of documents modified.

    Returns number

name

  • get name(): string

  • Returns string

upsertedCount

  • get upsertedCount(): number

  • Number of documents upserted.

    Returns number

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

  • Parameters

    • label: string

    Returns void

hasErrorLabel

  • 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

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function
      Optional

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc