Class MongoBulkWriteError

An error indicating an unsuccessful Bulk Write

Hierarchy (view full)

MongoServerError
- MongoBulkWriteError

Constructors

constructor

new MongoBulkWriteError(error, result): MongoBulkWriteError
Do not use this constructor!

Meant for internal use only.
Parameters
- error: AnyError | WriteConcernError | {
      code: number;
      message: string;
      writeErrors?: WriteError[];
  }
- result: BulkWriteResult
Returns MongoBulkWriteError
Remarks
This class is only meant to be constructed within the driver. This constructor is not subject to semantic versioning compatibility guarantees and may change at any time.
Overrides MongoServerError.constructor
- Defined in src/bulk/common.ts:621

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?: Document

errorResponse

errorResponse: ErrorDescription

Raw error result document returned by server.

message

message: string

`Optional`ok

ok?: number

result

result: BulkWriteResult

`Optional`stack

stack?: string

`Optional`topologyVersion

topologyVersion?: TopologyVersion

`Optional`writeConcernError

writeConcernError?: Document

writeErrors

writeErrors: OneOrMore<WriteError> = []

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Accessors

deletedCount

get deletedCount(): number
Number of documents deleted.

Returns number
- Defined in src/bulk/common.ts:658

errmsg

get errmsg(): string
Legacy name for server error responses

Returns string
Inherited from MongoServerError.errmsg
- Defined in src/error.ts:180

errorLabels

get errorLabels(): string[]
Returns string[]
Inherited from MongoServerError.errorLabels
- Defined in src/error.ts:198

insertedCount

get insertedCount(): number
Number of documents inserted.

Returns number
- Defined in src/bulk/common.ts:646

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
- Defined in src/bulk/common.ts:666

matchedCount

get matchedCount(): number
Number of documents matched for update.

Returns number
- Defined in src/bulk/common.ts:650

modifiedCount

get modifiedCount(): number
Number of documents modified.

Returns number
- Defined in src/bulk/common.ts:654

name

get name(): string
Returns string
Overrides MongoServerError.name
- Defined in src/bulk/common.ts:641

upsertedCount

get upsertedCount(): number
Number of documents upserted.

Returns number
- Defined in src/bulk/common.ts:662

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
- Defined in src/bulk/common.ts:670

Methods

addErrorLabel

addErrorLabel(label): void
Parameters
- label: string
Returns void
Inherited from MongoServerError.addErrorLabel
- Defined in src/error.ts:194

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
Inherited from MongoServerError.hasErrorLabel
- Defined in src/error.ts:190

`Static`captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from MongoServerError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

Class MongoBulkWriteError

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MongoBulkWriteError

Remarks

Properties

Optionalcause

Optionalcode

OptionalcodeName

OptionalconnectionGeneration

Optionalerr

OptionalerrInfo

errorResponse

message

Optionalok

result

Optionalstack

OptionaltopologyVersion

OptionalwriteConcernError

writeErrors

Static OptionalprepareStackTrace

See

StaticstackTraceLimit

Accessors

deletedCount

Returns number

errmsg

Returns string

errorLabels

Returns string[]

insertedCount

Returns number

insertedIds

Returns { [key: number]: any; }

[key: number]: any

matchedCount

Returns number

modifiedCount

Returns number

name

Returns string

upsertedCount

Returns number

upsertedIds

Returns { [key: number]: any; }

[key: number]: any

Methods

addErrorLabel

Parameters

Returns void

hasErrorLabel

Parameters

Returns boolean

StaticcaptureStackTrace

Parameters

Returns void

Settings

On This Page

`Optional`cause

`Optional`code

`Optional`codeName

`Optional`connectionGeneration

`Optional`err

`Optional`errInfo

`Optional`ok

`Optional`stack

`Optional`topologyVersion

`Optional`writeConcernError

`Static` `Optional`prepareStackTrace

`Static`stackTraceLimit

Returns {
[key: number]: any;
}

Returns {
[key: number]: any;
}

`Static`captureStackTrace