DOCSP-48249-export-schema

Author: jmd-mongo

source/images/compass/export-modal.png

@@ -0,0 +1,14 @@
+.. code-block:: json
+   :linenos:
+   :copyable: false
+
+   "year": {
+      "type": "integer",
+      "x-bsonType": "int",
+      "x-metadata": {
+         "hasDuplicates": true,
+         "probability": 0.95,
+         "count": 950, 
+      },
+      "x-sampleValues": [ "2003", "2020", "2023" ] 
+   },

source/images/compass/export-schema-button.png

@@ -0,0 +1,30 @@
+.. code-block:: json
+   :linenos:
+   :copyable: false
+
+   { 
+      $jsonSchema: {
+        bsonType: "object", 
+        required: ["title", "year"],
+        properties: {
+          _id: {
+            bsonType: "objectId"
+          }, 
+          title: { 
+            bsonType: "string",
+            description: "Title must be a string",
+          }, 
+          year: { 
+            bsonType: "int",
+            description: "Year must be an integer"
+          },
+          genres: {
+            bsonType: "array",
+            items: {
+              bsonType: "string"
+            },
+            description: "Genres must be an array of strings"
+          },
+        }
+      }
+   }

source/includes/export-output-expanded.rst

@@ -0,0 +1,27 @@
+.. code-block:: json
+   :linenos:
+   :copyable: false
+   
+   {
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "type": "object", 
+      "required": ["title", "year"],
+      "properties": {
+          "_id": {
+              "type": "string",
+              "description": "MongoDB's ObjectId"
+          }, 
+          "title": {
+            "type": "string" 
+   		  }, 
+   		  "year": { 
+            "type": "number"
+   		  },
+   		  "genres": {
+            "type": "array",
+            "items": {
+               "type": "string"
+            }
+       },
+     }
+   }

source/includes/export-output-mongodb.rst

@@ -0,0 +1,39 @@
+MongoDB format schema objects contain the following fields:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 25 35 40
+ 
+   * - Property
+     - Data type
+     - Description
+
+   * - ``type``
+     - string
+     - Data type of the field.
+
+   * - ``x-bsonType``
+     - string or array
+     - |bson| type of this field.
+
+   * - ``x-metadata``
+     - document
+     - Document containing metadata about the field.
+
+   * - ``x-metadata.hasDuplicates``
+     - boolean
+     - ``true`` if a single value of this data type appears multiple 
+       times in the corresponding field. Otherwise ``false``.
+
+   * - ``x-metadata.probability``
+     - float
+     - Probability that the value of the corresponding field is this 
+       data type in a random document.
+
+   * - ``x-metadata.count``
+     - integer
+     -  Number of documents sampled from the collection.
+
+   * - ``x-sampleValues``
+     - array
+     - Sample values as Expanded JSON.

source/includes/export-output-standard.rst

@@ -0,0 +1 @@
+TODO

source/includes/schema-export-format-expanded.rst

@@ -0,0 +1,44 @@
+Standard format schema objects contain the following fields:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 25 35 40
+ 
+   * - Property
+     - Data type
+     - Description
+
+   * - ``type``
+     - string or array
+     - |bson| type of this data type. For details, see the `official JSON 
+       docs <https://json-schema.org/draft/2020-12/json-schema-validation#name-type>`_.
+
+   * - ``anyOf``
+     - string
+     - For details, see the `official JSON docs 
+       <https://json-schema.org/draft/2020-12/json-schema-core#name-anyof>`_.
+   
+   * - ``required``
+     - string or array
+     - Fields that must appear in the schema. For details, see the 
+       `official JSON docs <https://json-schema.org/draft/2020-12/json-schema-validation#name-required>`_.
+
+   * - ``properties``
+     - document
+     - Properties for each field, such as ``type`` and ``description``.
+       For details, see the `official JSON docs 
+       <https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.1>`_.
+ 
+   * - ``properties.<field>.type``
+     - string
+     - The data type of the ``<field>``.
+
+   * - ``properties.<field>.description``
+     - string
+     - Human-readable description of the ``<field>``. 
+
+   * - ``properties.<field>.items``
+     - document
+     - Types of elements in array fields. For details, see the `official
+       JSON docs <https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.1.2>`_.
+