Name:
interface
Value:
Amplify has re-imagined the way frontend developers build fullstack applications. Develop and deploy without the hassle.

Page updated Apr 29, 2024

Additional DataStore methods

Amplify iOS v1 is deprecated as of June 1st, 2024. No new features or bug fixes will be added. Dependencies may become outdated and potentially introduce compatibility issues.

Please use the latest version (v2) of Amplify Library for Swift to get started. Refer to the upgrade guide for instructions on upgrading your application to the latest version.

Amplify libraries should be used for all new cloud connected applications. If you are currently using the AWS Mobile SDK for iOS, you can access the documentation here.

Clear

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

Amplify.DataStore.clear { result in
switch result {
case .success:
print("DataStore cleared")
case .failure(let error):
print("Error clearing DataStore: \(error)")
}
}

If your app uses authentication, it is recommended to call DataStore.clear() on sign-in or sign-out to remove any user-specific data. In scenarios where a mobile device can be shared by several users, calling DataStore.clear() will ensure that data does not leak from one user to another.

Start

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

Amplify.DataStore.start { result in
switch result {
case .success:
print("DataStore started")
case .failure(let error):
print("Error starting DataStore: \(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().

Amplify.DataStore.stop { result in
switch result {
case .success:
print("DataStore stopped")
case .failure(let error):
print("Error stopping DataStore: \(error)")
}
}