Skip to content

Commit

Permalink
(DOCSP-26114): Document `LocalConfiguration.shouldDeleteIfMigrationNe…
Browse files Browse the repository at this point in the history
…eded` (#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)
  • Loading branch information
mongodben committed Jan 13, 2023
1 parent e13a86b commit d00605f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/sdk/flutter/model-data/update-realm-object-schema.txt
Expand Up @@ -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
<flutter-manually-migrate-schema>`.

.. 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 <realm/LocalConfiguration/shouldDeleteIfMigrationNeeded.html>`
property to delete the database automatically when a schema mismatch
requires a migration.

.. important:: Modify Schema Properties of a Synced Realm

Expand Down

0 comments on commit d00605f

Please sign in to comment.