Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.
allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).
The number of documents to return per batch. See aggregation documentation.
return BSON regular expressions as BSONRegExp instances.
Allow driver to bypass schema validation in MongoDB 3.2 or higher.
the serializer will check if keys are valid.
A user-provided comment to attach to this command
Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
Specifies the verbosity mode for the explain output.
allow to specify if there what fields we wish to return as unserialized raw buffer.
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.
Add an index selection hint to an aggregation command
serialize will not emit undefined fields (default:true)
Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).
The maximum amount of time for the server to wait on new documents to satisfy a change stream query.
specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.
when deserializing a Binary will return it as a node.js Buffer instance.
when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).
Allows you to start a changeStream after a specified event. See ChangeStream documentation.
Should retry failed writes
Specify ClientSession for this command
Similar to resumeAfter, but will allow you to start after an invalidated event. See ChangeStream documentation.
Will start the changeStream after the specified operationTime.
Write Concern as an object
Generated using TypeDoc