Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BulkWriteResult

Hierarchy

  • BulkWriteResult

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

result

result: BulkResult
deprecated

Will be removed in 5.0

Accessors

insertedCount

  • get insertedCount(): number

  • Number of documents inserted.

    Returns number

matchedCount

  • get matchedCount(): number

  • Number of documents matched for update.

    Returns number

modifiedCount

  • get modifiedCount(): number

  • Number of documents modified.

    Returns number

deletedCount

  • get deletedCount(): number

  • Number of documents deleted.

    Returns number

upsertedCount

  • get upsertedCount(): number

  • Number of documents upserted.

    Returns number

upsertedIds

  • get upsertedIds(): {}

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

    Returns {}

    • [key: number]: any

insertedIds

  • get insertedIds(): {}

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

    Returns {}

    • [key: number]: any

ok

  • get ok(): number

  • Evaluates to true if the bulk operation correctly executes

    Returns number

nInserted

  • get nInserted(): number

  • The number of inserted documents

    Returns number

nUpserted

  • get nUpserted(): number

  • Number of upserted documents

    Returns number

nMatched

  • get nMatched(): number

  • Number of matched documents

    Returns number

nModified

  • get nModified(): number

  • Number of documents updated physically on disk

    Returns number

nRemoved

  • get nRemoved(): number

  • Number of removed documents

    Returns number

Methods

getInsertedIds

  • Returns an array of all inserted ids

    Returns <internal>.Document[]

getUpsertedIds

  • Returns an array of all upserted ids

    Returns <internal>.Document[]

getUpsertedIdAt

  • Returns the upserted id at the given index

    Parameters

    • index: number

    Returns <internal>.Document

getRawResponse

  • Returns raw internal result

    Returns <internal>.Document

hasWriteErrors

  • hasWriteErrors(): boolean

  • Returns true if the bulk operation contains a write error

    Returns boolean

getWriteErrorCount

  • getWriteErrorCount(): number

  • Returns the number of write errors off the bulk operation

    Returns number

getWriteErrorAt

  • Returns a specific write error object

    Parameters

    • index: number

    Returns WriteError

getWriteErrors

  • Retrieve all write errors

    Returns WriteError[]

getLastOp

  • Retrieve lastOp if available

    deprecated

    Will be removed in 5.0

    Returns <internal>.Document

getWriteConcernError

  • Retrieve the write concern error if one exists

    Returns WriteConcernError

toJSON

  • Returns BulkResult

toString

  • toString(): string

  • Returns string

isOk

  • isOk(): boolean

  • Returns boolean

Generated using TypeDoc