diff --git a/docs/Next/classes/ChangeStream.html b/docs/Next/classes/ChangeStream.html index 7aff1eb8c8..000ddd7fed 100644 --- a/docs/Next/classes/ChangeStream.html +++ b/docs/Next/classes/ChangeStream.html @@ -1,12 +1,12 @@
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.
Emitted each time the change stream stores a new resume token.
-Sets or gets the default captureRejection value for all emitters.
This symbol shall be used to install a listener for only monitoring 'error'
@@ -15,27 +15,27 @@
Installing a listener using this symbol does not change the behavior once an
'error'
event is emitted, therefore the process will still crash if no
regular 'error'
listener is installed.
Is the cursor closed
-The cached resume token that is used to resume after the most recently returned change.
-Close the Change Stream
-Check if there is any document still available in the Change Stream
-Get the next available document from the Change Stream.
-Return a modified Readable stream including a possible transform method.
NOTE: When using a Stream to process change stream events, the stream will NOT automatically resume in the case a resumable error is encountered.
Try to get the next available document from the Change Stream's cursor or null
if an empty batch is returned
Returns a copy of the array of listeners for the event named eventName
.
For EventEmitter
s this behaves exactly the same as calling .listeners
on
diff --git a/docs/Next/interfaces/ChangeStreamCollModDocument.html b/docs/Next/interfaces/ChangeStreamCollModDocument.html
index 3829e5cc14..951b75bcdc 100644
--- a/docs/Next/interfaces/ChangeStreamCollModDocument.html
+++ b/docs/Next/interfaces/ChangeStreamCollModDocument.html
@@ -1,28 +1,28 @@
Only present when the showExpandedEvents
flag is enabled.
The id functions as an opaque token for use when resuming an interrupted change stream.
-The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
-The UUID (Binary subtype 4) of the collection that the operation was performed on.
Only present when the showExpandedEvents
flag is enabled.
NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.
The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.
-Describes the type of operation represented in this change notification
-The transaction number. Only present if the operation is part of a multi-document transaction.
NOTE: txnNumber can be a Long if promoteLongs is set to false
diff --git a/docs/Next/interfaces/ChangeStreamCreateDocument.html b/docs/Next/interfaces/ChangeStreamCreateDocument.html index bc057aeb79..8978fb588f 100644 --- a/docs/Next/interfaces/ChangeStreamCreateDocument.html +++ b/docs/Next/interfaces/ChangeStreamCreateDocument.html @@ -1,26 +1,26 @@The id functions as an opaque token for use when resuming an interrupted change stream.
-The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
-The UUID (Binary subtype 4) of the collection that the operation was performed on.
Only present when the showExpandedEvents
flag is enabled.
NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.
The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.
-Describes the type of operation represented in this change notification
-The transaction number. Only present if the operation is part of a multi-document transaction.
NOTE: txnNumber can be a Long if promoteLongs is set to false
diff --git a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html index 67015d7b5d..85418cb4c0 100644 --- a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html +++ b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html @@ -1,32 +1,32 @@Only present when the showExpandedEvents
flag is enabled.
The id functions as an opaque token for use when resuming an interrupted change stream.
-The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
-The UUID (Binary subtype 4) of the collection that the operation was performed on.
Only present when the showExpandedEvents
flag is enabled.
NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.
The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.
-An description of the operation.
Only present when the showExpandedEvents
flag is enabled.
Describes the type of operation represented in this change notification
-The transaction number. Only present if the operation is part of a multi-document transaction.
NOTE: txnNumber can be a Long if promoteLongs is set to false
diff --git a/docs/Next/interfaces/ChangeStreamDeleteDocument.html b/docs/Next/interfaces/ChangeStreamDeleteDocument.html index e8f2513efa..3a45ec8b9b 100644 --- a/docs/Next/interfaces/ChangeStreamDeleteDocument.html +++ b/docs/Next/interfaces/ChangeStreamDeleteDocument.html @@ -1,37 +1,37 @@The id functions as an opaque token for use when resuming an interrupted change stream.
-The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
-The UUID (Binary subtype 4) of the collection that the operation was performed on.
Only present when the showExpandedEvents
flag is enabled.
NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.
For unsharded collections this contains a single field _id
.
For sharded collections, this will contain all the components of the shard key
Contains the pre-image of the modified or deleted document if the pre-image is available for the change event and either 'required' or 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option when creating the change stream. If 'whenAvailable' was specified but the pre-image is unavailable, this will be explicitly set to null.
-The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.
-Namespace the delete event occurred on
-Describes the type of operation represented in this change notification
-The transaction number. Only present if the operation is part of a multi-document transaction.
NOTE: txnNumber can be a Long if promoteLongs is set to false
diff --git a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html index 0aa0e27902..f35fbd44ad 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html @@ -1,4 +1,4 @@ -The UUID (Binary subtype 4) of the collection that the operation was performed on.
Only present when the showExpandedEvents
flag is enabled.
NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers diff --git a/docs/Next/interfaces/ChangeStreamDocumentCommon.html b/docs/Next/interfaces/ChangeStreamDocumentCommon.html index cf60a43419..1238e359b0 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCommon.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCommon.html @@ -1,17 +1,17 @@ -
The id functions as an opaque token for use when resuming an interrupted change stream.
-The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
-The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.
-The transaction number. Only present if the operation is part of a multi-document transaction.
NOTE: txnNumber can be a Long if promoteLongs is set to false
diff --git a/docs/Next/interfaces/ChangeStreamDocumentKey.html b/docs/Next/interfaces/ChangeStreamDocumentKey.html index 80d603a9f3..0e6174b8b4 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentKey.html +++ b/docs/Next/interfaces/ChangeStreamDocumentKey.html @@ -1,4 +1,4 @@ -For unsharded collections this contains a single field _id
.
For sharded collections, this will contain all the components of the shard key
Generated using TypeDoc
Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.
-