DOCSP-23220 Merge cherrypick (#1626)

kennethdyer · web-flow · commit f1a45fa004f4 · 2022-08-10T15:33:23.000-07:00
diff --git a/snooty.toml b/snooty.toml
@@ -88,6 +88,7 @@ toc_landing_pages = [
    "/mongo",
    "/reference/aggregation",
    "/reference/bson-types",
+   "/reference/change-events",
    "/reference/collation",
    "/reference/command",
    "/reference/command/nav-administration",
diff --git a/source/changeStreams.txt b/source/changeStreams.txt
@@ -506,6 +506,7 @@ upper-right to set the language of the examples on this page.
    See :ref:`change-stream-output` for more information on the change stream
    response document format.
 
+.. _change-streams-updateLookup:
 
 Lookup Full Document for Update Operations
 ------------------------------------------
diff --git a/source/includes/change-stream/clusterTime.rst b/source/includes/change-stream/clusterTime.rst
@@ -0,0 +1,18 @@
+.. _|idref|-clusterTime:
+
+The timestamp from the oplog entry associated with the event.
+
+Change stream event notifications associated with a
+:doc:`multi-document transaction </core/transactions>`
+all have the same ``clusterTime`` value: the time when the transaction
+was committed.
+
+On sharded clusters, events with the same ``clusterTime`` may not all
+relate to the same transaction.  Some events don't relate to a
+transaction at all.
+
+To identify events for a single transaction, you can use the
+combination of ``lsid`` and ``txnNumber`` in the change stream
+event document.
+
+.. versionadded:: 4.0
diff --git a/source/includes/change-stream/documentKey.rst b/source/includes/change-stream/documentKey.rst
@@ -0,0 +1,10 @@
+.. _|idref|-documentKey:
+
+Document that contains the ``_id`` value of the document created or 
+modified by the :ref:`CRUD <crud>` operation.
+
+For sharded collections, this field also displays the full shard key
+for the document. The ``_id`` field is not repeated if it is already a
+part of the shard key.
+
+
diff --git a/source/includes/change-stream/fullDocument-update.rst b/source/includes/change-stream/fullDocument-update.rst
@@ -0,0 +1,13 @@
+
+This field only appears if you configured the change stream with 
+``fullDocument`` set to ``updateLookup``. When you configure the change stream
+with ``updateLookup``, the field represents the current 
+majority-committed version of the document modified by the update operation.
+The document may differ from the changes described in 
+:ref:`updateDescription <|idref|-updateDescription>` if any other 
+majority-committed operations have modified the document between the original 
+update operation and the full document lookup.
+
+For more information, see :ref:`Lookup Full Document for Update Operations
+<change-streams-updateLookup>`.
+
diff --git a/source/includes/change-stream/fullDocument.rst b/source/includes/change-stream/fullDocument.rst
@@ -0,0 +1,3 @@
+.. _|idref|-fullDocument:
+
+The document created or modified by a :term:`CRUD` operation.
diff --git a/source/includes/change-stream/id.rst b/source/includes/change-stream/id.rst
@@ -0,0 +1,22 @@
+.. _|idref|-id:
+
+A :term:`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:
+
+.. code-block:: none
+
+   {
+      "_data" : <BinData|hex string>
+   }
+
+The ``_data`` type depends on the MongoDB versions
+and, in some cases, the :ref:`feature compatibility version (FCV)
+<view-fcv>` at the time of the change stream's
+opening or resumption. See :ref:`change-stream-resume-token` for the
+full list of ``_data`` types.
+
+For an example of resuming a change stream by ``resumeToken``, see 
+:ref:`change-stream-resume`.
+
diff --git a/source/includes/change-stream/lsid.rst b/source/includes/change-stream/lsid.rst
@@ -0,0 +1,9 @@
+.. _|idref|-lsid:
+
+The identifier for the session associated with the transaction.
+
+Only present if the operation is part of a :doc:`multi-document
+transaction </core/transactions>`.
+
+.. versionadded:: 4.0
+
diff --git a/source/includes/change-stream/ns.coll.rst b/source/includes/change-stream/ns.coll.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ns.coll:
+
+The name of the collection where the event occurred.
+
diff --git a/source/includes/change-stream/ns.db.rst b/source/includes/change-stream/ns.db.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ns.db:
+
+The name of the database where the event occurred.
+
diff --git a/source/includes/change-stream/ns.rst b/source/includes/change-stream/ns.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ns:
+
+The namespace (database and or collection) affected by the event.
+
diff --git a/source/includes/change-stream/operationType.rst b/source/includes/change-stream/operationType.rst
@@ -0,0 +1,4 @@
+.. _|idref|-operationType:
+
+The type of operation that the change notification reports.  
+
diff --git a/source/includes/change-stream/stateBeforeChange.collectionOptions.rst b/source/includes/change-stream/stateBeforeChange.collectionOptions.rst
@@ -0,0 +1,3 @@
+.. _|idref|-sbc.collectionOptions:
+
+Document shows collection options before the operation changed them.
diff --git a/source/includes/change-stream/stateBeforeChange.indexOptions.rst b/source/includes/change-stream/stateBeforeChange.indexOptions.rst
@@ -0,0 +1,3 @@
+.. _|idref|-sbc.indexOptions:
+
+Document shows index options before the operation changed them.
diff --git a/source/includes/change-stream/stateBeforeChange.rst b/source/includes/change-stream/stateBeforeChange.rst
@@ -0,0 +1,3 @@
+.. _|idref|-stateBeforeChange:
+
+Document shows collection and index options before the operation changed them.
diff --git a/source/includes/change-stream/to.coll.rst b/source/includes/change-stream/to.coll.rst
@@ -0,0 +1,4 @@
+.. _|idref|-to.coll:
+
+The new name of the collection after the rename. 
+
diff --git a/source/includes/change-stream/to.db.rst b/source/includes/change-stream/to.db.rst
@@ -0,0 +1,4 @@
+.. _|idref|-to.db:
+
+The new name of the database after the rename. 
+
diff --git a/source/includes/change-stream/to.rst b/source/includes/change-stream/to.rst
@@ -0,0 +1,4 @@
+.. _|idref|-to:
+
+The new namespace of the collection after the rename.
+
diff --git a/source/includes/change-stream/txnNumber.rst b/source/includes/change-stream/txnNumber.rst
@@ -0,0 +1,10 @@
+.. _|idref|-txnNumber:
+
+Together with the :ref:`lsid <|idref|-lsid>`, a number that helps uniquely
+identify a transction.
+
+Only present if the operation is part of a :doc:`multi-document
+transaction </core/transactions>`.
+
+.. versionadded:: 4.0
+
diff --git a/source/includes/change-stream/ud-removedFields.rst b/source/includes/change-stream/ud-removedFields.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ud-removedFields:
+
+An array of fields that were removed by the update operation.
+
diff --git a/source/includes/change-stream/ud-ta-field.rst b/source/includes/change-stream/ud-ta-field.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ud-ta-field:
+
+The name of the truncated field.
+
diff --git a/source/includes/change-stream/ud-ta-newSize.rst b/source/includes/change-stream/ud-ta-newSize.rst
@@ -0,0 +1,4 @@
+.. _|idref|-ud-ta-newSize:
+
+The number of elements in the truncated array.
+
diff --git a/source/includes/change-stream/ud-truncatedArrays.rst b/source/includes/change-stream/ud-truncatedArrays.rst
@@ -0,0 +1,17 @@
+.. _|idref|-ud-truncatedArrays:
+ 
+An array of documents which record array truncations performed
+with pipeline-based updates using one or more of the following
+stages:
+
+* :pipeline:`$addFields`
+* :pipeline:`$set`
+* :pipeline:`$replaceRoot`
+* :pipeline:`$replaceWith`
+
+.. note::
+
+   If the entire array is replaced, the truncations will be
+   reported under :ref:`updateDescription.updatedFields 
+   <|idref|-ud-updatedFields>`.
+
diff --git a/source/includes/change-stream/ud-updatedFields.rst b/source/includes/change-stream/ud-updatedFields.rst
@@ -0,0 +1,7 @@
+.. _|idref|-ud-updatedFields:
+
+A document whose keys correspond to the fields that were modified by the
+update operation. The value of each field corresponds to the new
+value of those fields, rather than the operation that resulted in the
+new value.
+
diff --git a/source/includes/change-stream/updateDescription.rst b/source/includes/change-stream/updateDescription.rst
@@ -0,0 +1,5 @@
+.. _|idref|-updateDescription:
+
+A document describing the fields that were updated or removed
+by the update operation.
+
diff --git a/source/reference/change-events.txt b/source/reference/change-events.txt
diff --git a/source/reference/change-events/delete.txt b/source/reference/change-events/delete.txt
diff --git a/source/reference/change-events/drop.txt b/source/reference/change-events/drop.txt
diff --git a/source/reference/change-events/dropDatabase.txt b/source/reference/change-events/dropDatabase.txt
diff --git a/source/reference/change-events/insert.txt b/source/reference/change-events/insert.txt
diff --git a/source/reference/change-events/invalidate.txt b/source/reference/change-events/invalidate.txt
diff --git a/source/reference/change-events/rename.txt b/source/reference/change-events/rename.txt
diff --git a/source/reference/change-events/replace.txt b/source/reference/change-events/replace.txt
diff --git a/source/reference/change-events/update.txt b/source/reference/change-events/update.txt

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.. _\|idref\|-fullDocument:`
	`2`	`+`
	`3`	+The document created or modified by a :term:`CRUD` operation.
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.. _|idref|-ns.coll:
++
 +The name of the collection where the event occurred.
++