Pause or Terminate Sync

Overview

If you want to disable Atlas Device Sync for your app, you can temporarily pause or permanently terminate it. You can also re-enable Device Sync after disabling it.

You can temporarily pause Device Sync if you need to pause your cluster. With a temporary pause, you can resume without resetting your Device Sync configuration or losing Device Sync metadata.

You can permanently terminate and re-enable Device Sync for troubleshooting or if you want to change your Device Sync configuration.

Pause Sync

You can pause Device Sync for a period of time without disabling it entirely. When you pause Device Sync, you stop syncing changes between Atlas and your application.

Pausing Device Sync rejects any incoming client connections. This means that pausing Device Sync for your App stops syncing changes for all clients.

To pause Device Sync from the client side, using logic that situationally pauses Device Sync during a session, see your preferred SDK:

After pausing Device Sync, you can re-enable it. Pausing Device Sync maintains the configuration settings and all of the Device Sync metadata, which contains the sync history. When you re-enable paused Device Sync, your clients can reconnect normally.

Procedure

1

Press the Pause Sync Button

In the Device Sync tab of the App Services UI, press the Pause Sync button.

2

Confirm That You Want to Pause Sync

In the modal that pops up, press the Pause Sync button.

3

Review Your Changes

Press the Review & Deploy button in the blue notification bar telling you that changes have been made to your App Services app.

4

Deploy Your App to Pause Sync

In the model that appears, review your changes and then press the green Deploy button.

You have now paused Device Sync and should get a green notification bar on the top of the Sync page that states that your deployment was successful.

Resume Sync

After you have paused Device Sync, you can resume it to begin syncing again for all clients.

Terminate Sync

If you have enabled Device Sync, you may have to terminate and re-enable Device Sync under a few different circumstances:

• An upgrade from a Shared Tier Atlas Cluster to a Shared or Dedicated instance

• A move to an Atlas cluster that is distributed across regions/cloud providers

• An upgrade to NVMe Atlas clusters

• An oplog rollover

• A paused Device Sync session on a shared tier cluster due to infrequent usage

• Troubleshooting, at the request of MongoDB Support

• Altering a Partition-Based Sync configuration

• Switching between Sync modes. For instance, if you are switching from Partition-Based Sync to Flexible Sync

• Dropping a collection you've used with Sync. For example, if you have a Team collection that stores and syncs Team objects, and then you drop that collection, you must terminate and re-enable Sync.

Procedure

Terminate Device Sync in your App to stop syncing data across devices.

1

Press the Terminate Sync Button

In the Sync tab of the App Services UI, click the red Terminate Sync button.

2

Confirm That You Want to Terminate Sync

In the modal that pops up, check that you want to terminate sync by clicking the I want to terminate Sync checkbox and then click the Terminate Sync button on the modal.

3

Review Your Changes

Click the Review & Deploy button in the blue notification bar telling you that changes have been made to your App Services app.

4

Deploy Your App to Terminate Sync

In the model that appears, review your changes and then click the green Deploy button.

You have now terminated Device Sync and should get a green notification bar on the top of the Sync page that states that your deployment was successful.

Re-Enable Sync

After you have terminated Device Sync, you can re-enable it. Re-enabling Device Sync enables your App to begin syncing changes to Atlas again. After you re-enable Device Sync, your App begins accepting incoming client connections again. However, if a client had previously connected to your App before you terminated Device Sync, you must perform a client reset for that client to enable it to connect to App Services again.