From d00605f0b0effbfac0123c250df383e7d0ed0985 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <90647379+mongodben@users.noreply.github.com> Date: Fri, 13 Jan 2023 14:34:51 -0500 Subject: [PATCH] (DOCSP-26114): Document `LocalConfiguration.shouldDeleteIfMigrationNeeded` (#2425) ## Pull Request Info Document `LocalConfiguration.shouldDeleteIfMigrationNeeded`. ### Jira - https://jira.mongodb.org/browse/DOCSP-26114 ### Staged Changes - [Update Realm Object Schema](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26114/sdk/flutter/model-data/update-realm-object-schema) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --- .../sdk/flutter/model-data/update-realm-object-schema.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/sdk/flutter/model-data/update-realm-object-schema.txt b/source/sdk/flutter/model-data/update-realm-object-schema.txt index 01e722e6a5..b4d73afb5d 100644 --- a/source/sdk/flutter/model-data/update-realm-object-schema.txt +++ b/source/sdk/flutter/model-data/update-realm-object-schema.txt @@ -24,6 +24,13 @@ You must perform a manual migration for all other schema changes. For more information, refer to the :ref:`Manually Migrate Schema section `. +.. tip:: Bypass Migration During Development + + When developing or debugging your application, you may prefer to delete + the realm instead of migrating it. Use the + :flutter-sdk:`LocalConfiguration.shouldDeleteIfMigrationNeeded ` + property to delete the database automatically when a schema mismatch + requires a migration. .. important:: Modify Schema Properties of a Synced Realm