Uploaded image for project: 'Realm Cocoa SDK'
  1. Realm Cocoa SDK
  2. RCOCOA-995

Document handling a client reset for RealmSync

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • Labels:

      Documentation in the new MongoDB docs section does not contain any mention of handling a client reset process correctly without data loss for the iOS SDK. There is some existing documentation here but it isn't up to date with the new APIs. From what I can tell some documentation also exists for the JavaSDK and the .NETSDK.

      I think this section is quite important and could do with a more indepth example and documentation of how to recover from a sync error. For example, the following stack overflow entry has some details on a possible recovery process here

      Goals

      I believe new users should be able to implement best practises when using RealmSync and avoid data loss in the case of an unhandled or incorrectly handled client reset. This should be documented and simple example implementation displayed and explained, the process of persisting a realm path, displaying a message to the user, restarting the client and restoring from a backed up Realm would be a simple use case to display. Without this documentation users run the risk of data loss.

            Assignee:
            chris.bush@mongodb.com Chris Bush
            Reporter:
            unitosyncbot Unito Sync Bot
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: