createIndexes Event
On this page
Summary
createIndexes
New in version 6.0.
A
createIndexes
event occurs when an index is created on the collection and the change stream has the showExpandedEvents option set totrue
.
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. | |||
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. 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. | |||
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. indexes | array | An array of documents listing the indexes that were created by the operation. New in version 6.0. | |||
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. | |||
wallTime | The server date and time of the database operation. New in version 6.0. |
Example
The following example shows a createIndexes
event:
{ "_id": { <ResumeToken> }, "operationType": "createIndexes", "clusterTime": Timestamp({ t: 1651257835, i: 1 }), "collectionUUID": UUID("06bced37-7cc8-4267-96aa-a58a422153d8"), "wallTime": ISODate("2022-04-29T18:43:55.160Z"), "ns": { "db": "test", "coll": "authors" }, "operationDescription": { "indexes": [ { "v": 2, "key": { "name": 1 }, "name": "name_1" } ] } }