DOCSP-22283 validate extensions (#1910)

jason-price-mongodb · jason-price-mongodb · web-flow · commit ceed21f793fb · 2022-10-04T16:51:38.000-07:00
* DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions * DOCSP-22283-validate-extensions Co-authored-by: jason-price-mongodb <jshfjghsdfgjsdjh@aolsdjfhkjsdhfkjsdf.com>
diff --git a/source/includes/fact-validate-conformance.rst b/source/includes/fact-validate-conformance.rst
@@ -0,0 +1,15 @@
+*Optional*. If ``true``, the collection is checked to ensure the
+:ref:`BSON documents <bson-document-format>` conform to the BSON
+specifications. The checks increase the time to complete the validation
+operation. Any issues are returned as a warning.
+
+``checkBSONConformance``:
+
+- Default is ``false``.
+- Is enabled when ``full`` is set to ``true``.
+- Cannot be used with:
+
+  - ``repair`` set to ``true``.
+  - ``metadata`` set to ``true``.
+
+.. versionadded:: 6.2
diff --git a/source/includes/validate-improvements-introduction.rst b/source/includes/validate-improvements-introduction.rst
@@ -0,0 +1,10 @@
+Starting in MongoDB 6.2, the :dbcommand:`validate` command and
+:method:`db.collection.validate()` method:
+
+- Check collections to ensure the
+  :ref:`BSON documents <bson-document-format>` conform to the BSON
+  specifications.
+- Check :ref:`time series collections <manual-timeseries-collection>`
+  for internal data inconsistencies.
+- Have a new option ``checkBSONConformance`` that enables comprehensive
+  BSON checks.
diff --git a/source/reference/command/validate.txt b/source/reference/command/validate.txt
@@ -13,12 +13,14 @@ validate
 Definition
 ----------
 
+.. versionchanged:: 6.2
+
 .. dbcommand:: validate
 
    The :dbcommand:`validate` command checks a collection's data and
    indexes for correctness and returns the results.
 
-   Starting in version 5.0, the :dbcommand:`validate` command can also
+   Starting in MongoDB 5.0, the :dbcommand:`validate` command can also
    find inconsistencies in the collection and fix them if possible.
 
    .. include:: /includes/fact-validate-standalone-inconsistencies.rst
@@ -35,18 +37,17 @@ Definition
 Syntax
 ------
 
-.. versionchanged:: 5.0
-
 The command has the following syntax:
 
 .. code-block:: javascript
 
    db.runCommand( 
       { 
-        validate: <string>,          // Collection name
-        full: <boolean>,             // Optional
-        repair: <boolean>,           // Optional, added in MongoDB 5.0
-        metadata: <boolean>          // Optional, added in MongoDB 5.0.4
+        validate: <string>,  // Collection name
+        full: <boolean>,  // Optional
+        repair: <boolean>,  // Optional, added in MongoDB 5.0
+        metadata: <boolean>,  // Optional, added in MongoDB 5.0.4
+        checkBSONConformance: <boolean>  // Optional, added in MongoDB 6.2
       } 
    )
 
@@ -60,7 +61,7 @@ The command takes the following fields:
 
 .. list-table::
    :header-rows: 1
-   :widths: 10 10 50
+   :widths: 15 15 70
 
    * - Field
      - Type
@@ -103,6 +104,12 @@ The command takes the following fields:
 
        .. include:: /includes/fact-validate-metadata.rst
 
+   * - :ref:`checkBSONConformance <cmd-validate-checkBSONConformance>`
+     - boolean
+     - .. _cmd-validate-checkBSONConformance:
+
+       .. include:: /includes/fact-validate-conformance.rst
+
 Behavior
 --------
 
@@ -131,6 +138,11 @@ Data Throughput Metrics
 
 .. include:: /includes/extracts/4.4-validate-data-throughput.rst
 
+Collection Validation Improvements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/validate-improvements-introduction.rst
+
 Restrictions
 ~~~~~~~~~~~~~
 
@@ -173,6 +185,14 @@ Examples
 
     db.runCommand( { validate: "myCollection", metadata: true } )
 
+- To perform additional BSON conformance checks in ``myCollection``,
+  specify :ref:`checkBSONConformance: true
+  <cmd-validate-checkBSONConformance>`:
+
+  .. code-block:: javascript
+
+    db.runCommand( { validate: "myCollection", checkBSONConformance: true } )
+
 .. _validate-output:
 
 Validate Output
@@ -182,6 +202,12 @@ Validate Output
 
 Specify :ref:`full: true <cmd-validate-full>` for more detailed output.
 
+.. data:: validate.uuid
+
+   The universally unique identifier (UUID) for the collection.
+
+   .. versionadded:: 6.2
+
 .. data:: validate.nInvalidDocuments
 
    The number of invalid documents in the collection. Invalid documents
@@ -194,6 +220,11 @@ Specify :ref:`full: true <cmd-validate-full>` for more detailed output.
    Non-compliant documents are not counted as invalid in
    :data:`~validate.nInvalidDocuments`.
 
+   Starting in MongoDB 6.2, ``nNonCompliantDocuments`` also includes the
+   number of documents that do not conform to the :term:`BSON`
+   or :ref:`time series collection <manual-timeseries-collection>`
+   requirements.
+
 .. data:: validate.nrecords
 
    The number of :term:`documents <document>` in the collection.
diff --git a/source/reference/method/db.collection.validate.txt b/source/reference/method/db.collection.validate.txt
@@ -15,6 +15,8 @@ db.collection.validate()
 Description
 -----------
 
+.. versionchanged:: 6.2
+
 .. method:: db.collection.validate(<documents>)
 
    .. include:: /includes/fact-mongosh-shell-method.rst
@@ -39,15 +41,14 @@ Syntax
    :method:`db.collection.validate()` no longer accepts just a boolean
    parameter. See :ref:`4.4-validate-method-signature`.
 
-.. versionchanged:: 5.0
-
 The :method:`db.collection.validate()` method has the following syntax:
 
 .. code-block:: javascript
 
    db.collection.validate( { 
-      full: <boolean>,          // Optional
-      repair: <boolean>         // Optional, added in MongoDB 5.0
+      full: <boolean>,  // Optional
+      repair: <boolean>,  // Optional, added in MongoDB 5.0
+      checkBSONConformance: <boolean>  // Optional, added in MongoDB 6.2
    } )
 
 Parameters
@@ -58,7 +59,7 @@ following optional document parameter with the fields:
 
 .. list-table::
    :header-rows: 1
-   :widths: 10 10 50
+   :widths: 15 15 70
 
    * - Field
      - Type
@@ -93,6 +94,13 @@ following optional document parameter with the fields:
 
        .. include:: /includes/fact-validate-repair-option.rst
 
+   * - :ref:`checkBSONConformance
+       <method-validate-checkBSONConformance>`
+     - boolean
+     - .. _method-validate-checkBSONConformance:
+
+       .. include:: /includes/fact-validate-conformance.rst
+
 Behavior
 --------
 
@@ -142,6 +150,11 @@ Data Throughput Metrics
 
 .. include:: /includes/extracts/4.4-validate-data-throughput.rst
 
+Collection Validation Improvements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/validate-improvements-introduction.rst
+
 Examples
 --------
 
@@ -170,4 +183,12 @@ Examples
 
      db.myCollection.validate( { repair: true } )
 
+- To perform additional BSON conformance checks in ``myCollection``,
+  specify :ref:`checkBSONConformance: true
+  <method-validate-checkBSONConformance>`:
+
+  .. code-block:: javascript
+
+    db.myCollection.validate( { checkBSONConformance: true } )
+
 For details of the output, see :ref:`validate-output`.
diff --git a/source/release-notes/6.2.txt b/source/release-notes/6.2.txt
@@ -63,6 +63,11 @@ these output changes:
        range.
        Total number of connection requests for all time ranges.
 
+Collection Validation Improvements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/validate-improvements-introduction.rst
+
 Server Parameters
 -----------------
 
