DOCS-14821 Adding metadata flag context to validate()

source/includes/fact-validate-metadata.rst

@@ -0,0 +1,33 @@
+*Optional*. A flag which allows users to perform a quick validation to 
+detect invalid index options without scanning all of the documents and 
+indexes.
+
+- If ``true``, a metadata validation scan is performed.
+
+- If ``false``, no metadata validation scan is not performed.
+
+The default is ``false``.
+
+Running the validate command with ``{ metadata: true }`` is not 
+supported with any other :dbcommand:`validate` options.
+
+The ``metadata`` validation option:
+
+- Provides you a faster way of identifying invalid indexes by scanning 
+  only collections metadata.
+
+- Provides an alternative to dropping and recreating multiple invalid 
+  indexes when used with the :doc:`collMod </reference/command/collMod>` 
+  command.
+
+The ``metadata`` validation option only scans collection metadata to 
+find invalid indexes more quickly.
+
+If there is an invalid index detected, the validate command will prompt
+you to use the :dbcommand:`collMod` command to remove invalid indexes.
+
+.. code-block:: javascript
+
+   db.runCommand( { collMod: <collectionName> } )
+
+.. versionadded:: 5.0.4

source/includes/fact-validate-repair-option.rst

@@ -29,7 +29,8 @@ The repair fixes these issues:
 - If corrupt documents with invalid BSON data are found, the documents
   are removed.
 
-.. seealso:: :option:`--repair <mongod --repair>` option for
-   :binary:`~bin.mongod`
+.. seealso::
+
+   :option:`--repair <mongod --repair>` option for :binary:`~bin.mongod`
 
 .. versionadded:: 5.0

source/reference/command/validate.txt

@@ -44,7 +44,8 @@ The command has the following syntax:
    db.runCommand( { 
       validate: <string>,          // Collection name
       full: <boolean>,             // Optional
-      repair: <boolean>            // Optional, added in MongoDB 5.0
+      repair: <boolean>,           // Optional, added in MongoDB 5.0
+      metadata: <boolean>          // Optional, added in MongoDB 5.0.4
    } )
 
 :binary:`~bin.mongosh` also provides a wrapper
@@ -96,6 +97,12 @@ The command takes the following fields:
 
        .. include:: /includes/fact-validate-repair-option.rst
 
+   * - :ref:`metadata <cmd-validate-metadata>`
+     - boolean
+
+     - .. _cmd-validate-metadata:
+
+       .. include:: /includes/fact-validate-metadata.rst
 
 Behavior
 --------
@@ -159,6 +166,13 @@ Examples
 
     db.runCommand( { validate: "myCollection", repair: true } )
 
+- To validate the metadata in the ``myCollection`` collection, 
+  specify :ref:`meta data: true <cmd-validate-metadata>`:
+
+  .. code-block:: javascript
+
+    db.runCommand( { validate: "myCollection", metadata: true } )
+
 .. _validate-output:
 
 Validate Output

source/release-notes/5.1.txt

@@ -104,6 +104,14 @@ single-field non-TTL index.
 General Improvements
 --------------------
 
+Metadata Option Added for ``validate`` Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting in MongoDB 5.1 (and MongoDB 5.0.4), the :dbcommand:`validate` 
+command and the :method:`db.collection.validate()` helper method have a 
+new :ref:`metadata <cmd-validate-metadata>` option that quickly 
+validates collections and detects invalid index options.
+
 ``serverStatus`` Output Change
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~