- Change Streams >
- Change Events >
- invalidate
invalidate¶
On this page
Summary¶
-
invalidate
¶ An
invalidate
event occurs when an operation renders the change stream invalid. For example, a change stream opened on a collection that was later dropped or renamed would cause aninvalidate
event.
Description¶
Field | Type | Description |
---|---|---|
_id |
Document | A BSON object which serves as an identifier for the
change stream event. This value is used as the The For an example of resuming a change stream by |
clusterTime |
Timestamp | The timestamp from the oplog entry associated with the event. Change stream event notifications associated with a
multi-document transaction
all have the same On sharded clusters, events with the same To identify events for a single transaction, you can use the
combination of New in version 4.0. |
operationType |
string | The type of operation that the change notification reports. Returns a value of |
Example¶
The following example illustrates an invalidate
event:
Change streams opened on collections raise an invalidate
event when a
drop, rename,
or dropDatabase operation occurs
that affects the watched collection.
Change streams opened on databases raise an invalidate
event when a
dropDatabase event occurs that affects
the watched database.
invalidate
events close the change stream cursor.
You cannot use resumeAfter
to resume a change stream after an
invalidate event (for example, a collection
drop or rename) closes the stream. Starting in MongoDB 4.2, you can use
startAfter to start a new change
stream after an invalidate event.