DOCSP-37727 dryRun Flag (#6813)

* DOCSP-37727 dryRun Flag * typos * JD feedback * *
mongodb · Mar 20, 2024 · 03a36f9 · 03a36f9
1 parent 98b6177
commit 03a36f9
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 7 deletions.
diff --git a/source/includes/fact-compact-dryrun.rst b/source/includes/fact-compact-dryrun.rst
@@ -0,0 +1,4 @@
+If enabled, the ``compact`` command returns an estimate of how much space, in 
+bytes, compaction can reclaim from the targeted collection. If you run 
+``compact`` with ``dryRun`` set to ``true``, MongoDB only returns the estimated 
+value and does not perform any kind of compaction. 
diff --git a/source/reference/command/compact.txt b/source/reference/command/compact.txt
@@ -29,7 +29,8 @@ The command has the following syntax:
    db.runCommand(
       { 
         compact: <string>, 
-        force: <flag>, // Optional
+        dryRun: <boolean>,
+        force: <boolean>, // Optional
         freeSpaceTargetMB: <int>, // Optional 
         comment: <any>, // Optional
       }
@@ -52,16 +53,23 @@ The command takes the following fields:
      - string
      - The name of the collection.
 
+   * - ``dryRun``
+     - boolean
+     - .. versionadded:: 8.0
+
+       .. include:: /includes/fact-compact-dryrun.rst 
+
+       *Default:* False
+
    * - ``force``
-     - flag
+     - boolean
      - .. versionchanged:: 4.4 
 
        .. _compact-force-option:
 
-       Optional. If specified, forces 
-       ``compact`` to run on the :term:`primary` in 
-       a :term:`replica set`. ``compact`` does not block 
-       :ref:`crud` on the database it is compacting. 
+       Optional. If enabled, forces ``compact`` to run on the :term:`primary` in 
+       a :term:`replica set`. ``compact`` does not block :ref:`crud` on the 
+       database it is compacting. 
 
    * - ``freeSpaceTargetMB`` 
      - Integer 

diff --git a/source/release-notes/8.0.txt b/source/release-notes/8.0.txt
@@ -17,14 +17,23 @@ Release Notes for MongoDB 8.0 (Release Candidate)
 General Changes
 ---------------
 
+Compaction Improvements
+~~~~~~~~~~~~~~~~~~~~~~~
+
 Background Compaction 
-~~~~~~~~~~~~~~~~~~~~~
+`````````````````````
 
 Starting in MongoDB 8.0, you can use the new :dbcommand:`autoCompact` command 
 to perform background compaction. If enabled, the server attempts to keep free 
 space within each collection and index below the specified the 
 ``freeSpaceTargetMB`` value.
 
+dryRun Option 
+`````````````
+
+.. include:: /includes/fact-compact-dryrun.rst 
+
+
 New Bulk Write Command
 ~~~~~~~~~~~~~~~~~~~~~~