Navigation

Configure Your Data Model

Overview

In modern applications, users expect their data to be accurate no matter which device or browser they connect from. Data modeling ensures the accuracy of application data by performing type and format checks on fields.

MongoDB Realm allows you to define, synchronize, and enforce your data model in two formats:

  • Realm Schema, which defines your data as MongoDB documents to enforce validation and synchronization in the cloud.
  • Realm data model, which defines your data as native objects in your mobile application.

Having these two forms of data models allows your data to be consistent and synced regardless of which clients write the data.

Approaches

There are two alternative approaches to configuring both data models:

  • Create a Realm Object Model from a Realm Schema: If you have data in your MongoDB Atlas cluster already, MongoDB generates a Realm Schema by sampling your data. MongoDB Realm can then translate that Realm Schema into a Realm Object Model to use in your mobile application.
  • Create a Realm Schema from a Realm Object Model: Alternatively, if you are developing mobile-first and do not already have data in your Atlas cluster, you can translate your Realm Object Model into a Realm Schema for use with Atlas. Regardless of the approach that you take, when you configure both your Atlas cluster and Mobile application to use the respective data model, changes to the data model between the server and client are auto-updated.

Create a Realm Object Model from a Realm Schema

You can generate and edit a Realm Schema if you already have data in MongoDB Atlas. MongoDB Realm creates your Realm Schema as a result of a sample of your data already stored in your cluster. This schema can be edited before it is translated into a Realm Object Model in order to synchronize the two models and perform data validation on your mobile application.

Link a MongoDB Atlas Cluster

Your Realm app must have at least one linked Atlas cluster in order to define a Realm Data Model.

1

Define a Realm Schema

To get started, ensure you have a Realm Schema defined. MongoDB Realm will translate this Realm Schema into a Realm Object Model to be configured and utilized in your mobile application.

Primary Key _id Required

To work with Realm Sync, your data model must have a primary key field called _id. _id can be of type string, int, or objectId.

Note

To learn how to define a Realm Schema for at least one collection in the synced cluster, see the Enforce a Document Schema page.

2

View the Realm Object Model

The Realm Object Model defines and validates your data in your mobile client application. To view your Realm Object Model, navigate to the SDKs page, where you can view your Realm Schema as a generated Realm Object Model in your language of choice.

3

View and Fix Schema Errors

Realm may fail to generate some or all of your Realm Object Model based on your Realm Schema. You can view a list of the errors in your Realm Schema that prevented Realm from generating the Realm Object Model on the SDKs page of the Realm UI.

Common errors include mismatched types, and differences in the way relationships are represented in the two respective models. For each error or warning, modify your Realm Schema to fix the specified issue.

Note

To learn more about the technical differences between the two data models read the Realm Object Model Restrictions page.

4

Open a Realm with the Realm Object Model

You can immediately use the generated Realm Object Model in your client application. In order to begin enforcing data validation with your data model, you can open a Realm with the Realm Object Model. This will prevent improper data from entering your database from your mobile client. Click Copy on the right-hand side of the Realm Object Model for the Object Model you want to integrate into your mobile application code. This will copy the Realm Object Model code for the SDK of your choice into your clipboard. Open your mobile application code in your IDE and paste the Realm Object Model code in.

const UserSchema = { // your copied and pasted Realm Object Model
  name: 'User',
  properties: {
    _id: 'objectId',
    _partition: 'string',
    name: 'string',
    birthday: 'date'
  },
  primaryKey: '_id'
};
// Initialize a Realm with your Realm Object Model
Realm.open({schema: UserSchema, sync: { /* ... */ }})
  .then(realm => {
    // ... use the realm instance to read and modify data
  })

See also

Sync Data on iOS

Create a Realm Schema from a Realm Object Model

When you link a MongoDB Realm application to an Atlas cluster, updating your Realm Object Model will automatically update your Realm Schema if Development Mode is on in the MongoDB Realm UI. Turn off Development Mode to generate a Realm Schema based on your Realm Object Model for your Atlas cluster to use.

Link a MongoDB Atlas Cluster

Your Realm app must have at least one linked Atlas cluster in order to define a Realm Data Model.

1

Enable Sync with Development Mode

First, ensure you have enabled sync with Development Mode on. To do that, see Enable Sync.

You can alter or define a Realm Object Model through your mobile client SDK. Changes to your Realm Object Model are only allowed when Development Mode is on in the MongoDB Realm UI. MongoDB Realm will reflect these changes to your Realm Object Model in your Realm Schema used for Atlas.

2

Edit Your Realm Object Model

As you continue to develop your application, you will need to modify your data model with it to enforce different data validation rules based on those changes. While Development Mode is on, you can edit your Realm Object Model in your client code. Data Validation occurs when Development Mode is off, so MongoDB Realm does not accept changes to your Realm Object Model while Development Mode is not on.

Primary Key _id Required

To work with Realm Sync, your data model must have a primary key field called _id. _id can be of type string, int, or objectId.

Example

A group is developing a social media application. When the group first developed their application, a user’s birthday was a required field of the User’s data model. However, due to privacy concerns over the amount of user data that is stored, management creates a new requirement to make the user’s birthday field an optional field. Application developers turn on Development Mode in the MongoDB Realm UI and then edit their user model within their client code.

const realmObjectModel = {
  name: 'User',
  properties: {
    _id: 'objectId',
    _partition: 'string',
    name: 'string',
    birthday: {type: 'date', optional: true}, // developers set optional: true to adhere to the new requirement
  },
  primaryKey: '_id'
};

Realm.open({schema: realmObjectModel, sync: {/*...*/}})
  .then(realm => {
    // ... use the realm instance to read and modify data
  })

See also

Sync Data on iOS

3

Update Your Realm Schema with the Realm Object Model Changes

While Development Mode is on, MongoDB Realm doesn’t validate writes against your data model, allowing you to freely update your Realm Object Model. When you turn off Development Mode, MongoDB Realm automatically updates your Realm Schema and starts to enforce data validation for your Atlas cluster based on it.

Click the “Turn Dev Mode Off” button on the top right-hand side of the SDKs page to turn off Development Mode. Once you turn off Development Mode, the “Development Mode is OFF” modal will appear. The modal indicates that MongoDB Realm has stopped accepting new data model changes from clients. Click the “View my Realm Schema” button on the modal to view your updated Realm Schema.

Note

To make future data model updates from your mobile client code, you can follow this procedure again.

Summary

  • MongoDB Realm uses two different data models: a Realm Object Model for mobile and a Realm Schema for Atlas. Changes to one data model match the other data model.
  • If you already have data in Atlas, MongoDB Realm creates a Realm Schema by sampling that data. That Realm Schema can be translated into a Realm Object Model to be used in your Realm mobile application code.
  • If you do not have data in Atlas or are developing with a mobile-first approach, you can turn on Development Mode to allow for data model changes from a Realm mobile client. When you finish developing your Realm Object Model, you can turn off Development Mode, and your Realm Schema will be auto-updated with your updated data model configuration. Atlas will begin using this updated data model configuration for data validation on your cluster immediately.