rename
Event
On this page
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 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. | |||
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.db | string | The name of the database where the event occurred. | |||
ns.coll | string | The name of the collection where the event occurred. | |||
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. New in version 4.0. |
Example
The following example illustrates a rename
event:
{ "_id": { <Resume Token> }, "operationType": "rename", "clusterTime": <Timestamp>, "ns": { "db": "engineering", "coll": "users" }, "to": { "db": "engineering", "coll": "people" } }
A rename
event leads to an
invalidate event for change streams opened
against its ns
collection or to
collection.