Enable Development Mode¶
Realm Sync is currently in Beta.
Overview¶
Development mode allows you to define and update your app's schemas by syncing objects from a Realm SDK. While enabled, Realm does not enforce any data access rules and does not validate synced objects against existing schemas. Instead, Realm maps every synced object type to its own collection and automatically updates the collection schema to match the synced type.
As the name suggests, development mode is an insecure development utility that is not suitable for production use. Make sure that you turn off development mode before you make your app accessible in a production environment.
Procedure¶
Navigate to the Sync Configuration Screen¶
To configure and enable development mode for your application, navigate to to the Sync configuration screen through the left navigation menu and then click the Development Mode tab.
Select a Cluster to Sync¶
You can enable development mode sync for a single linked cluster in your application. Determine which cluster you want to use and then select it from the Select Cluster To Sync dropdown menu.
Choose a Target Database¶
While development mode is enabled, Realm maps every synced object type to its own collection in the linked cluster. The collections use the pluralized name of the object type and are located in a specific database.
Determine which database in the linked cluster you want to contain the synced data and then enter it into the Define a Database Name input.
Choose a Partition Key¶
The sync partition key is a field in every synced document that maps each document to a client-side realm. Sync rules apply at the partition level, so it is particularly important to consider your data model and access patterns. For more information on partition keys and how to choose one, see Partition Atlas Data into Realms.
Once you have decided which field to use, enter the field name into the Choose A Partition Key input.
Turn On Development Mode¶
Click Turn Dev Mode On to enable development mode.