Docs Menu

Docs Home → Atlas App Services

Sync Data in Atlas with a Client Application

On this page

  • Set up Atlas Access
  • Create an Atlas App Services App
  • Configure Device Sync
  • Enable an Authentication Provider
  • Generate Client Object Models
  • Add Sync to the Client Application
  • Connect the client to an App Services backend
  • Authenticate a User
  • Open a Synced Realm
  • Use the Synced Realm

If your organization already has data in MongoDB Atlas, you can sync that data to client devices using Device Sync and Realm Database. Follow these high-level steps to get started:

Set up Atlas Access

1

Create an Atlas App Services App

The App Services application is the gateway that enables your client device to connect to MongoDB Atlas. When you create an App, you name it, link it to an Atlas cluster, and specify the deployment model and deployment region that work best for your application.

To learn how to create an App Services App, see Create an App.

2

Configure Device Sync

Device Sync is the service that manages synchronizing your Atlas data with your client devices. Device Sync, together with the Realm SDKs, automatically manages network connectivity, conflict resolution, user authentication, and user permissions and data access.

When you configure Device Sync, you specify the data source that the client devices can access, as well as the permissions that determine what data a user can read and write.

You can configure Device Sync via the Atlas UI, the Atlas App Services Command Line Interface, or the App Services Admin API. The first time you configure Device Sync, you may find it helpful to use the Atlas UI as it provides links and information about various settings and options.

3

Enable an Authentication Provider

Your client users must authenticate in order to access synced data. App Services provides several authentication providers to enable your users to authenticate. Configure one or more of these authentication providers to enable authentication in your client application.

You can configure authentication providers within the App Services App UI by selecting Authentication in the left navigation menu, and then click a provider to configure it. You can also configure authentication providers by editing the App Services configuration with the Atlas App Services Command Line Interface, or the App Services Admin API.

4

Generate Client Object Models

When you already have data in Atlas, you can generate object models that match that data to use in your client application.

To generate an object model, you must have an App Services schema. Once you have a schema, you can generate object models that match that schema. You can select a programming language to use to generate the schema, which you can then view and copy to use in your client application code.

You can generate a schema from existing Atlas data using the App Services UI. For more information on how to do this, refer to: Create a Realm Object Schema from an App Services Schema.

Once you have a schema, you can generate a Realm object model using the App Services UI or the Atlas App Services Command Line Interface.

Add Sync to the Client Application

After this, you've got everything set up that you need on the Atlas side, and you can prepare your client application to sync data. Device Sync synchronizes data with Atlas using a Realm Database SDK. You can use the Realm SDK in your client application code to connect to Atlas and sync data with a Realm Database on the device.

1

Connect the client to an App Services backend

In your client application code, initialize an App client to connect your client to your App Services backend. This lets your client use App Services features like authentication, and enables opening a synced realm.

2

Authenticate a User

Your client application user must be authenticated with the App Services backend in order to access synchronized data. Add logic to your client app to register and log in users.

3

Open a Synced Realm

Once you have an authenticated user, you can open a synchronized instance of Realm Database to use for that user.

You define a Flexible Sync query subscription in your client code to determine what data to sync to the client application. Device Sync looks for Atlas documents that match the query, which the user has permission to read and possibly write, and synchronizes those documents to the client device as Realm objects. You can add, remove, or update Flexible Sync query subscriptions to change the documents that sync to the device.

4

Use the Synced Realm

The syntax to read, write, and watch for changes on a synced realm is identical to the syntax for non-synced realms. While you work with local data, a background thread efficiently integrates, uploads, and downloads changesets. When a user who has write permissions makes changes on the device, the data persists locally. When the user has a network connection, the data automatically syncs back to Atlas and other devices.

For a quick guide to how to do common tasks with Realm Database, refer to the Realm SDK quick starts.

If you prefer to study a working client app to learn, some of the SDKs provide a working Device Sync app, which we call template apps. Optionally, you can go through SDK-specific tutorials that build on the Device Sync template app.

← Device Sync Permissions Guide
Sync Data in a Client Application with Atlas and Other Devices →

On this page