Node.js MongoDB Driver API

Class: ChangeStream

ChangeStream

new ChangeStream(changeDomain, pipeline, options){ChangeStream}

lib/change_stream.js, line 15

Creates a new Change Stream instance. Normally created using Collection.watch().

Name Type Description
changeDomain MongoClient | Db | Collection

The domain against which to create the change stream
pipeline Array

An array of aggregation pipeline stages through which to pass change stream documents
options object optional

Optional settings

Name Type Default Description
fullDocument string 'default' optional

Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.
maxAwaitTimeMS number optional

The maximum amount of time for the server to wait on new documents to satisfy a change stream query
resumeAfter object optional

Specifies the logical starting point for the new change stream. This should be the _id field from a previously returned change stream document.
batchSize number optional

The number of documents to return per batch. See aggregation documentation.
collation object optional

Specify collation settings for operation. See aggregation documentation.
readPreference ReadPreference optional

The read preference. Defaults to the read preference of the database or collection. See read preference documentation.
Since:
  • 3.0.0
Fires:
Returns:
ChangeStream instance.

Methods

close(callback){Promise}

lib/change_stream.js, line 149

Close the Change Stream

Name Type Description
callback ChangeStream~resultCallback optional

The result callback.
Returns:
Promise if no callback passed

hasNext(callback){Promise}

lib/change_stream.js, line 106

Check if there is any document still available in the Change Stream

Name Type Description
callback ChangeStream~resultCallback optional

The result callback.
Throws:
MongoError
Returns:
Promise if no callback passed

isClosed(){boolean}

lib/change_stream.js, line 137

Is the cursor closed

next(callback){Promise}

lib/change_stream.js, line 117

Get the next available document from the Change Stream, returns null if no more documents are available.

Name Type Description
callback ChangeStream~resultCallback optional

The result callback.
Throws:
MongoError
Returns:
Promise if no callback passed

pause(){null}

lib/change_stream.js, line 210

This method will cause a stream in flowing mode to stop emitting data events. Any data that becomes available will remain in the internal buffer.

pipe(destination, options){null}

lib/change_stream.js, line 174

This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

Name Type Description
destination Writable

The destination for writing data
options object optional

Pipe options

resume(){null}

lib/change_stream.js, line 218

This method will cause the readable stream to resume emitting data events.

stream(options){Cursor}

lib/change_stream.js, line 201

Return a modified Readable stream including a possible transform method.

Name Type Description
options object optional

Optional settings.

Name Type Description
transform function optional

A transformation method applied to each document emitted by the stream.

unpipe(destination){null}

lib/change_stream.js, line 187

This method will remove the hooks set up for a previous pipe() call.

Name Type Description
destination Writable optional

The destination for writing data

Type Definitions

resultCallback(error, result)

lib/change_stream.js, line 470

The callback format for results

Name Type Description
error MongoError

An error instance representing the error during the execution.
result object | null

The result object if the command was executed successfully.

Events

change

lib/change_stream.js, line 231

Fired for each new matching change in the specified namespace. Attaching a change
event listener to a Change Stream will switch the stream into flowing mode. Data will
then be passed as soon as it is available.

Type:
  • object

close

lib/change_stream.js, line 245

Change stream close event

Type:
  • null

end

lib/change_stream.js, line 255

Change stream end event

Type:
  • null

error

lib/change_stream.js, line 265

Fired when the stream encounters an error.

Type:
  • Error