Database Manual / Change Streams / Change Events

createIndexes Event

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 to true.

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 `resumeToken` for the `resumeAfter` parameter when resuming a change stream. The `_id` object has the following form: `{ "_data" : <BinData\|hex string> }` The `_data` type depends on the MongoDB versions and, in some cases, the feature compatibility version (FCV) at the time of the change stream's opening or resumption. See Resume Tokens for the full list of `_data` types. For an example of resuming a change stream by `resumeToken`, see Resume a Change Stream.
`clusterTime`	Timestamp	`clusterTime` is the timestamp from the oplog entry associated with the event. Due to oplog size limits, multi-document transactions may create multiple oplog entries. In a transaction, change stream events staged in a given oplog entry share the same `clusterTime`. Events with the same `clusterTime` may not all relate to the same transaction. Some events don't relate to a transaction at all. Starting in MongoDB 8.0, this may be true for events on any deployment. In previous versions, this behavior was possible only for events on a sharded cluster. To identify events for a single transaction, you can use the combination of `lsid` and `txnNumber` in the change stream event document. 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.` `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 `createIndexes` for these change events.
`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`	ISODate	The server date and time of the database operation. `wallTime` differs from `clusterTime` in that `clusterTime` is a timestamp taken from the oplog entry associated with the database operation event. 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" }
      ]
   }
}

Back

create

delete