Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChangeStreamOptions

ChangeStreamOptions

Hierarchy

  • ChangeStreamOptions

Index

Properties

Optional batchSize

batchSize: number

The number of documents to return per batch.

Optional collation

Specify collation settings for operation.

Optional fullDocument

fullDocument: string

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.

Optional maxAwaitTimeMS

maxAwaitTimeMS: number

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

Optional readPreference

readPreference: ReadPreference

The read preference. Defaults to the read preference of the database or collection.

Optional resumeAfter

resumeAfter: Object

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

Generated using TypeDoc