(DOCSP-33216): Document new binData subtype 8 (#4812)

jeff-allen-mongo · web-flow · commit 3b6eb3d84a38 · 2023-09-29T11:32:13.000-04:00
* (DOCSP-26200): queryStats aggregation stage * WIP * WIP * WIP * Remove accidental file * add TODO * add missing ref * formatting * WIP * WIP * WIP * wording * WIP * edits * add examples * try to fix table format * add transformed example * remove TODO * more table formatting * add atlas data collection * table formatting * clarity * add more context for data collection * table formatting * wording tweaks * address review comments * formatting * use simplified examples * add input/output * edits * add link to transformed example * spacing * edits * address review comments * fix incomplete sentence * rework transformation section * edits * fix collation link formatting * change wording for output fields * edit glossary * more edits * remove glossary entry * formatting * edits * (DOCSP-33216): Document new binData subtype 8 * edits * Address review feedback * wording * review feedback * wording * tweaks * typo * clarification * review edit * address review comments * wording * formatting * WIP review edits * remove Atlas data collection info * (DOCSP-33347): Re-add Atlas data collection info * typo * minimalism * typo * clarity * remove Atlas data collection info * edits * (DOCSP-33347): Re-add Atlas data collection info * add find queryShape properties * change case * formatting * abstracted > normalized consistency * clarify privilege * address review comments * review edits
diff --git a/source/includes/binary-subtypes.rst b/source/includes/binary-subtypes.rst
@@ -0,0 +1,39 @@
+.. list-table::
+    :header-rows: 1
+
+    * - Number
+      - Description
+
+    * - 0
+      - Generic binary subtype
+
+    * - 1
+      - Function data
+
+    * - 2
+      - Binary (old)
+ 
+    * - 3
+      - UUID (old)
+
+    * - 4
+      - UUID
+
+    * - 5
+      - MD5
+ 
+    * - 6
+      - Encrypted BSON value
+
+    * - 7
+      - Compressed time series data
+
+        .. versionadded:: 5.2
+
+    * - 8
+      - Sensitive data, such as a key or secret. MongoDB does not log
+        literal values for binary data with subtype 8. Instead, MongoDB
+        logs a placeholder value of ``###``.
+
+    * - 128
+      - Custom data
diff --git a/source/reference/bson-types.txt b/source/reference/bson-types.txt
@@ -48,42 +48,9 @@ Binary Data
 
 A BSON binary ``binData`` value is a byte array. A ``binData`` value
 has a subtype that indicates how to interpret the binary data. The
-following table shows the subtypes.
+following table shows the subtypes:
 
-.. list-table::
-    :header-rows: 1
-
-    * - Number
-      - Subtype
-
-    * - 0
-      - Generic binary subtype
-
-    * - 1
-      - Function data
-
-    * - 2
-      - Binary (old)
- 
-    * - 3
-      - UUID (old)
-
-    * - 4
-      - UUID
-
-    * - 5
-      - MD5
- 
-    * - 6
-      - Encrypted BSON value
-
-    * - 7
-      - Compressed time series data
-
-        .. versionadded:: 5.2
- 
-    * - 128
-      - Custom data
+.. include:: /includes/binary-subtypes.rst
 
 .. _document-bson-type-object-id:
 .. _objectid:
diff --git a/source/reference/method/BinData.txt b/source/reference/method/BinData.txt
@@ -33,52 +33,27 @@ Creates a binary data object.
 
       * - ``sub_type``
 
-        - string
-
-        - The binary type.
-
-          .. list-table::
-            :header-rows: 1
-            :widths: 40 60
-
-            * - Subtype
-              - Description
-
-            * - 0
-
-              - Generic binary subtype
-
-            * - 1
-
-              - Function
-
-            * - 2
-
-              - Byte Array
+        - integer
 
-            * - 3
+        - The :ref:`binary subtype <binData-subtype>`
 
-              - OLD UUID
-
-            * - 4
-
-              - UUID
-
-            * - 5
+      * - ``buffer``
 
-              - MD5
+        - string
 
-            * - 128
+        - The buffer object containing binary data. Must be a base 64
+          encoded string value.
 
-              - User defined
+   :returns: A binary data object.
 
-      * - ``buffer``
+.. _binData-subtype:
 
-        - string
+Binary Subtypes
+~~~~~~~~~~~~~~~
 
-        - The buffer object containing binary data, must be a base 64 encoded string value.
+Specify one of the following values for ``sub_type``:
 
-   :returns: A binary data object.
+.. include:: /includes/binary-subtypes.rst
 
 Examples
 --------
@@ -136,4 +111,4 @@ The returned value is:
 .. code-block:: javascript
    :copyable: false
 
-   16
+   16
