Additional DataStore methods

Clear

To stop DataStore sync process and to clear local data from DataStore, use the clear method:

do {
    try await Amplify.DataStore.clear()
    print("DataStore cleared")
} catch let error as DataStoreError {
    print("Error clearing DataStore: \(error)")
} catch {
    print("Unexpected error \(error)")
}

Start

Synchronization starts automatically whenever you run any DataStore operation (query(), save(), delete().) You can also explicitly begin the process with DataStore.start():

do {
    try await Amplify.DataStore.start()
    print("DataStore started")
} catch let error as DataStoreError {
    print("Error starting DataStore: \(error)")
} catch {
    print("Unexpected error \(error)")
}

Stop

To stop the DataStore sync process, you can use DataStore.stop(). This will close the real time subscription connection when your app is no longer interested in updates. You will typically call DataStore.stop() just before your application is closed. You can also force your DataStore sync expressions to be re-evaluated at runtime by calling stop() followed by start().

do {
    try await Amplify.DataStore.stop()
    print("DataStore stopped")
} catch let error as DataStoreError {
    print("Error stopping DataStore: \(error)")
} catch {
    print("Unexpected error \(error)")
}