(DOCSP-15472): [Config Files] Sync

Author: nlarew

source/config/data_sources.txt

@@ -40,7 +40,6 @@ MongoDB Clusters
      "config": {
        "clusterName": "<Atlas Cluster Name>",
        "readPreference": "<Read Preference>",
-       "sync": { <Sync Configuration> },
        "wireProtocolEnabled": <Boolean>
      }
    }
@@ -75,103 +74,11 @@ MongoDB Clusters
 
        .. include:: /mongodb/tables/read-preference-modes.rst
 
-   * - | ``config.sync``
-       | Document
-     - A configuration document that determines if a cluster is :doc:`synced
-       </sync>` and, if it is, defines the rules for sync operations on the
-       cluster.
-
-       For detailed information on sync configuration documents, see
-       :ref:`Synced Cluster Configuration <config-synced-cluster>`.
-   
    * - | ``config.wireProtocolEnabled``
        | Boolean   
      - If ``true``, clients may :ref:`connect to the app over the MongoDB Wire
        Protocol <wire-protocol-connect>`.
 
-.. _config-synced-cluster:
-
-Synced Cluster Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The ``config.sync`` field of ``config.json`` determines if a cluster is
-:doc:`synced </sync>` and, if it is, defines the rules for sync operations on
-the cluster.
-
-.. code-block:: json
-   :caption: config.json
-
-   {
-     ...,
-     "config": {
-       ...,
-       "sync": {
-         "state": <Boolean>,
-         "development_mode_enabled": <Boolean>,
-         "database_name": "<Developer Mode Database Name>",
-         "partition": {
-           "key": "<Partition Key Field Name>",
-           "type": "<Partition Key Value Type>",
-           "permissions": {
-             "read": <JSON Expression>,
-             "write": <JSON Expression>
-           }
-         }
-       }
-     }
-   }
-
-.. list-table::
-   :header-rows: 1
-   :widths: 10 30
-
-   * - Field
-     - Description
-   
-   * - | ``sync.state``
-       | Boolean
-     - If ``true``, :doc:`Sync </sync>` is enabled for the cluster, which means
-       that client applications can sync data in the cluster with Realm Database
-       and that :ref:`non-sync collection rules <mongodb-service-rules>` do not
-       apply.
-   
-   * - | ``sync.development_mode_enabled``
-       | Boolean
-     - If ``true``, :term:`development mode` is enabled for the cluster. While
-       enabled, Realm automatically stores synced objects in a specific database
-       within the cluster and mirrors objects types in that database's
-       collection schemas.
-       
-       .. important::
-          
-          Realm does not enforce rules when development mode is enabled.
-
-   * - | ``sync.database_name``
-       | String
-     - The name of the database in the synced cluster where Realm should store
-       synced objects.
-       
-       When :term:`development mode` is enabled, Realm stores synced objects in
-       this database. Each object type maps to its own collection in the
-       database with a schema that matches the synced objects.
-   
-   * - | ``sync.partition.key``
-       | String
-     - The name of the field that :ref:`partitions <partitioning>` data into
-       client Realms.
-   
-   * - | ``sync.partition.type``
-       | String
-     - The type of the partition key field value.
-   
-   * - | ``sync.partition.permissions``
-       | Document
-     - A document that defines the ``read`` and ``write`` permissions for the
-       synced cluster. Permissions are defined with :ref:`rule expressions
-       <expressions>` that Realm evaluates per-user, per-partition. The
-       expressions have access to the :json-expansion:`%%user` and
-       :json-expansion:`%%partition` expansions.
-
 .. _config-datalake:
 
 MongoDB Data Lakes
@@ -211,7 +118,6 @@ MongoDB Data Lakes
        | String   
      - Required. The name of the data lake in Atlas.
 
-
 Databases & Collections
 -----------------------
 

source/config/sync.txt

@@ -29,15 +29,17 @@ Configuration
 
    {
      "state": <"enabled" | "disabled">,
-     "development_mode_enabled": <Boolean>
+     "development_mode_enabled": <Boolean>,
+     "database_name": "<Development Mode Database Name>",
      "partition": {
        "key": "<Partition Key Field Name>",
        "type": "<Partition Key Type>",
        "permissions": {
          "read": { <JSON Expression> },
          "write": { <JSON Expression> }
        }
-     }
+     },
+     "last_disabled": <Number>
    }
 
 .. list-table::
@@ -49,17 +51,35 @@ Configuration
 
    * - | ``state``
        | String
-     - The current state of the Sync protocol for the application.
+     - The current state of the :doc:`Sync </sync>` protocol for the application.
 
        Valid Options:
 
        - ``"enabled"``
        - ``"disabled"``
 
+   * - | ``service_name``
+       | String
+     - The name of the Atlas cluster :ref:`data source <appconfig-data_sources>`
+       to sync.
+
    * - | ``development_mode_enabled``
        | Boolean
      - If ``true``, :ref:`development mode <enable-development-mode>` is enabled
-       for the application.
+       for the application. While enabled, Realm automatically stores synced
+       objects in a specific database (specified in ``database_name``) and
+       mirrors objects types in that database's collection schemas.
+       
+       .. important::
+          
+          Realm does not enforce rules when development mode is enabled.
+
+   * - | ``database_name``
+       | String
+     - The name of a database in the synced cluster where Realm stores data in
+       :ref:`development mode <enable-development-mode>`. Realm automatically
+       generates a schema for each synced type and maps each object type to a
+       collection within the database.
 
    * - | ``partition.key``
        | String
@@ -91,3 +111,9 @@ Configuration
        has permission to write objects in a partition. If the expression
        evaluates to ``false``, {+service-short+} does not allow the user to
        modify an object or its properties.
+
+   * - | ``last_disabled``
+       | Number
+     - The date and time that sync was last paused or disabled, represented by
+       the number of seconds since the Unix epoch (January 1, 1970, 00:00:00
+       UTC).