- Change Streams >
- Change Events >
- delete Event
delete Event¶
On this page
Synopsis¶
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. |
documentKey |
document | Document that contains the For sharded collections, this field also displays the full shard key
for the document. The |
lsid |
document | The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction. New in version 4.0. |
ns |
document | The namespace (database and or collection) affected by the event. |
ns.coll |
string | The name of the collection where the event occurred. |
ns.db |
string | The name of the database where the event occurred. |
operationType |
string | The type of operation that the change notification reports. Returns a value of |
txnNumber |
NumberLong | Together with the lsid, a number that helps uniquely identify a transction. Only present if the operation is part of a multi-document transaction. New in version 4.0. |
Example¶
The following example illustrates a delete
event:
The fullDocument
document is omitted as the document no longer exists at the
time the change stream cursor sends the delete
event to the client.