Node.js MongoDB Driver API

Class: BulkOperationBase

BulkOperationBase

Parent class to OrderedBulkOperation and UnorderedBulkOperation

new BulkOperationBase(){OrderedBulkOperation|UnordedBulkOperation}

lib/bulk/common.js, line 697

Create a new OrderedBulkOperation or UnorderedBulkOperation instance (INTERNAL TYPE, do not instantiate directly)

Properties:
Name Type Description
length number

Get the number of operations in the bulk.

Methods

bulkExecute(bulk, writeConcern, options, callback)

lib/bulk/common.js, line 950

Execute next write command in a chain

Name Type Description
bulk class

either OrderedBulkOperation or UnorderdBulkOperation
writeConcern object
options object
callback function

execute(options, callback){Promise}

lib/bulk/common.js, line 1001

Execute the ordered bulk operation

Name Type Description
options object optional

Optional settings.

Name Type Default Description
w number | string optional

The write concern.
wtimeout number optional

The write concern timeout.
j boolean false optional

Specify a journal write concern.
fsync boolean false optional

Specify a file sync write concern.
callback BulkOperationBase~resultCallback optional

The result callback
Throws:

  • Throws error if the bulk object has already been executed

    Type
    MongoError

  • Throws error if the bulk object does not have any operations

    Type
    MongoError
Returns:
Promise if no callback passed

finalOptionsHandler(config, callback)

lib/bulk/common.js, line 1022

Handles final options before executing command

Name Type Description
config object
Name Type Description
options object
batch number
resultHandler function
callback function

find(selector)

lib/bulk/common.js, line 827

Initiate a find operation for an update/updateOne/remove/removeOne/replaceOne

Name Type Description
selector object

The selector for the bulk operation.
Throws:
MongoError

handleWriteError(callback, writeResult, self)

lib/bulk/common.js, line 1107

Handles the write error before executing commands

Name Type Description
callback function
writeResult BulkWriteResult
self class

either OrderedBulkOperation or UnorderdBulkOperation

insert(document){OrderedBulkOperation|UnorderedBulkOperation}

lib/bulk/common.js, line 814

Add a single insert document to the bulk operation

Name Type Description
document object

the document to insert
Throws:
MongoError

raw(op){OrderedBulkOperation|UnorderedBulkOperation}

lib/bulk/common.js, line 847

Raw performs the bulk operation

Name Type Description
op object

operation

Type Definitions

resultCallback(error, result)

lib/bulk/common.js, line 981

The callback format for results

Name Type Description
error MongoError

An error instance representing the error during the execution.
result BulkWriteResult

The bulk write result.