Class MongoBulkWriteError

An error indicating an unsuccessful Bulk Write

Hierarchy

MongoServerError
- MongoBulkWriteError

Index

Constructors

constructor

new MongoBulkWriteError(error, result): MongoBulkWriteError
Creates a new MongoBulkWriteError
Parameters
- error: WriteConcernError | AnyError | {
      code: number;
      message: string;
      writeErrors?: WriteError[];
  }
- result: BulkWriteResult
Returns MongoBulkWriteError
Overrides MongoServerError.constructor
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4249

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

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  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 packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4262

errmsg

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

Returns string
Inherited from MongoServerError.errmsg
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4735

errorLabels

get errorLabels(): string[]
Returns string[]
Inherited from MongoServerError.errorLabels
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4744

insertedCount

get insertedCount(): number
Number of documents inserted.

Returns number
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4256

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 packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4266

matchedCount

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

Returns number
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4258

modifiedCount

get modifiedCount(): number
Number of documents modified.

Returns number
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4260

name

get name(): string
Returns string
Overrides MongoServerError.name
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4254

upsertedCount

get upsertedCount(): number
Number of documents upserted.

Returns number
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4264

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 packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4270

Methods

addErrorLabel

addErrorLabel(label): void
Parameters
- label: string
Returns void
Inherited from MongoServerError.addErrorLabel
- Defined in packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4743

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 packages/@biorate/mongodb/node_modules/mongodb/mongodb.d.ts:4742

`Static` captureStackTrace

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

Class MongoBulkWriteError

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

error: WriteConcernError | AnyError | { code: number; message: string; writeErrors?: WriteError[]; }

result: BulkWriteResult

Returns MongoBulkWriteError

Properties

Optional cause

Optional code

Optional codeName

Optional connectionGeneration

Optional err

Optional errInfo

message

Optional ok

result

Optional stack

Optional topologyVersion

Optional writeConcernError

writeErrors

Static Optional prepareStackTrace

Type declaration

Parameters

err: Error

stackTraces: CallSite[]

Returns any

See

Static stackTraceLimit

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

label: string

Returns void

hasErrorLabel

Parameters

label: string

Returns boolean

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Settings

Member Visibility

Theme

On This Page

error: WriteConcernError | AnyError | {
code: number;
message: string;
writeErrors?: WriteError[];
}

`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

`Optional` constructorOpt: Function