DOCS-15230 changeStreamOptions cluster parameter (#1149)

* DOCS-15230 changeStreamOptions cluster parameter

* DOCS-15230 added release note

* DOCS-15230 fixed accidental deletion

* DOCS-15230 internal feedback

* DOCS-15230 rearranging description

* DOCS-15230 cluster parameter

* DOCS-15230 cluster parameter

* DOCS-15230 cluster parameter

* DOCS-15230 cluster parameter

* DOCS-15230 nit change

* DOCS-15230 restructuring parameter

* DOCS-15230 restructuring parameter

* DOCS-15230 restructuring parameter

* DOCS-15230 restructuring parameter

* DOCS-15230 restructuring parameter

* DOCS-15230 mongos & mongod

* DOCS-15230 add replace

* DOCS-15230 zoom changes

* DOCS-15230 correcting to mongos

* DOCS-15230 tech feedback

* DOCS-15230 updating ref link

* DOCS-15230 updating ref link

* DOCS-15230 updating ref link

* DOCS-15230 updating ref

Co-authored-by: Jocelyn Mendez <[email protected]>

Author: jocelyn-mendez1

source/reference/cluster-parameters.txt

@@ -32,3 +32,55 @@ To view the current values of cluster parameters, use the
 
 Parameters
 ----------
+
+.. |mongod-only| replace:: Available for :binary:`~bin.mongod` only.
+
+.. |mongos-only| replace:: Available for :binary:`~bin.mongos` only.
+
+.. |both| replace:: Available for both :binary:`~bin.mongod` and :binary:`~bin.mongos`.
+
+.. parameter:: changeStreamOptions
+
+   .. versionadded:: 6.0
+
+   |both|
+   
+   This is an object containing :ref:`change stream <change-streams-update-event>` 
+   configuration options. 
+
+   You can only set ``changeStreamOptions`` on mongos or a 
+   replica set primary. The value is set cluster-wide.
+   
+   .. parameter:: changeStreamOptions.preAndPostImages.expireAfterSeconds
+   
+      .. versionadded:: 6.0
+
+      *Default*: off
+   
+      Controls the retention policy of change stream pre- and post-images.
+      Pre- and post-images are the versions of a document before and after 
+      document modification respectively. ``expireAfterSeconds`` 
+      controls how long pre- and post-images are retained. 
+
+      When ``expireAfterSeconds`` is ``off``, MongoDB uses the default retention 
+      policy: pre- and post-images are retained until the corresponding change 
+      stream events are removed from the :term:`oplog`.  
+
+      To specify the minimum pre- and post-image retention time:
+      
+      - Set ``expireAfterSeconds`` using an integer. 
+      
+      - If a change stream event is removed from the oplog, then the 
+        corresponding pre- and post-images are also deleted regardless of the 
+        ``expireAfterSeconds`` pre- and post-image retention time.
+
+      The following example sets the retention time for pre- and post-images in 
+      change streams to ``100 seconds``:
+
+      .. code-block:: javascript
+
+         db.runCommand( {
+            setClusterParameter: {
+            changeStreamOptions: { preAndPostImages: { expireAfterSeconds: 100 } }
+            }
+         } )

source/release-notes/6.0.txt

@@ -173,6 +173,17 @@ Starting in MongoDB 6.0, you can use
 minimum and maximum sharding TaskExecutor connection pool size for
 :ref:`configuration servers <sharding-config-server>`.
 
+``changeStreamOptions`` Cluster Parameter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting in MongoDB 6.0, you can use :parameter:`changeStreamOptions` to control 
+the retention policy of change stream pre- and post-images.
+
+Multiple Arbiters Unsupported
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/support-multiple-arbiters.rst
+
 Clustered Collections
 ---------------------