rename
Event
Summary
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 Events with the same To identify events for a single transaction, you can use the
combination of Changed in version 8.0. | |||
collectionUUID | UUID | UUID identifying the collection where the change occurred. New in version 6.0. | |||
lsid | document | The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction. | |||
ns | document | The namespace (database and or collection) affected by the event. | |||
ns.db | string | The name of the database where the event occurred. | |||
ns.coll | string | The name of the collection where the event occurred. | |||
operationDescription | document | Additional information on the change operation. This document and its subfields only appears when the change stream uses expanded events. New in version 6.0. | |||
operationDescription. dropTarget | UUID | UUID of the collection that was dropped in the rename operation. New in version 6.0. | |||
operationDescription. to | document | The new namespace of the collection after the rename. New in version 6.0. | |||
operationDescription. to.coll | document | The new name of the collection after the rename. New in version 6.0. | |||
operationDescription. to.db | document | The new name of the database after the rename. New in version 6.0. | |||
operationType | string | The type of operation that the change notification reports. Returns a value of | |||
to | document | The new namespace of the collection after the rename. | |||
to.coll | document | The new name of the collection after the rename. | |||
to.db | document | The new name of the database after the rename. | |||
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. | |||
wallTime | The server date and time of the database operation. New in version 6.0. |
Behavior
Expanded Event Information
Changed in version 6.0.
Starting in MongoDB 6.0, when the showExpandedEvents option is set to true
for the change
stream, the rename
event includes an operationDescription
document.
This document provides a to
field showing the changed database and
collection and a dropTarget
field indicating whether the rename
operation removed the collection before the rename.
Example
The following example illustrates a rename
event:
{ "_id": { <Resume Token> }, "operationType": "rename", "clusterTime": <Timestamp>, "wallTime": <ISODate>, "ns": { "db": "engineering", "coll": "users" }, "to": { "db": "engineering", "coll": "people" }, "operationDescription": { "to": { "db": "engineering", "coll": "people" } } }
A rename
event leads to an
invalidate event for change streams opened
against its ns
collection or to
collection.