Amplify DataStore provides a programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios, which makes working with distributed, cross-user data just as simple as working with local-only data.
Note: this allows you to start persisting data locally to your device with DataStore, even without an AWS account.
GoalTo setup and configure your application with Amplify DataStore and use it to persist data locally on a device.
PrerequisitesAn application with Amplify libraries integrated and a minimum target of any of the following:
For a full example, please follow the project setup walkthrough.
visionOS support is currently in preview and can be used by using the latest Amplify Release. As new Xcode and visionOS versions are released, the support will be updated with any necessary fixes on a best effort basis.
Install Amplify LibrariesTo install Amplify Libraries in your application, open your project in Xcode and select File > Add Packages....
Enter the Amplify Library for Swift GitHub repo URL (https://github.com/aws-amplify/amplify-swift) into the search bar and click Add Package.
Note: Up to Next Major Version should be selected from the Dependency Rule dropdown.
To use Amplify, you must first initialize it for use in your project. If you haven't already done so, run this command:
The base structure for a DataStore app is created by adding a new GraphQL API to your app.
The CLI will prompt you to configure your API. Select GraphQL as the API type and reply to the questions as shown below. Conflict detection is required when using DataStore to sync data with the cloud.
? Please select from one of the below mentioned services:
? Here is the GraphQL API that we will create. Select a setting to edit or continue:
? Here is the GraphQL API that we will create. Select a setting to edit or continue:
`Authorization modes: API key (default, expiration time: 7 days from now)`
? Choose the default authorization type for the API
? Enter a description for the API key:
? After how many days from now the API key should expire (1-365):
? Configure additional auth types?
? Here is the GraphQL API that we will create. Select a setting to edit or continue:
`Conflict detection (required for DataStore): Disabled`
? Enable conflict detection?
? Select the default resolution strategy
? Here is the GraphQL API that we will create. Select a setting to edit or continue:
? Choose a schema template
`Single object with fields (e.g., âTodoâ with ID, name, description)`
Troubleshooting: Cloud sync will fail without the conflict detection configuration. To enable it for an existing project, run amplify update api and choose Enable conflict detection (required for DataStore).
The amplify add api command adds a new AmplifyConfig group to your Xcode project. It will contain the following files:
AmplifyConfig/
amplifyconfiguration.jsonawsconfiguration.jsonschema.graphqlDataStore relies on platform standard data structures to represent the data schema in an idiomatic way. The persistence language is composed by data types that satisfies the Model interface and operations defined by common verbs such as save, query and delete.
The first step to create an app backed by a persistent datastore is to define a schema. DataStore uses GraphQL schema files as the definition of the application data model. The schema contains data types and relationships that represent the app's functionality.
Sample schemaFor the next steps, let's start with a schema for a small blog application. Currently, it has only a single model. New types and constructs will be added to this base schema as more concepts are presented.
Open the schema.graphql file located by default at amplify/backend/{api_name}/ and define a model Post as follows.
Now you will to convert the platform-agnostic schema.graphql into platform-specific data structures. DataStore relies on code generation to guarantee schemas are correctly converted to platform code.
Like the initial setup, models can be generated either using the IDE integration or Amplify CLI directly.
Code generation: Platform integrationOn iOS the amplify CLI offers an Xcode integration that automatically adds the Amplify-specific files to your project.
Run the command:
The amplify codegen models command adds a new AmplifyModels group to your Xcode project. It will contain the following files:
AmplifyModels/
AmplifyModels.swiftPost.swiftPost+Schema.swiftPostStatus.swiftCmd+b).Models can also be generated using the Amplify CLI directly.
In your terminal, make sure you are in your project/root folder and execute the codegen command:
You can find the generated files at amplify/generated/models/.
To initialize the Amplify DataStore call Amplify.add(plugin:) method and add the AWSDataStorePlugin, then call Amplify.configure().
Add the following imports to the top of your AppDelegate.swift file:
Add the following code
In your App scene, configure Amplify in the initializer:
Add to your AppDelegate's application:didFinishLaunchingWithOptions method
Upon building and running this application you should see the following in your console window:
Amplify configured with DataStore plugin
Now the application is ready to execute persistence operations. The data will be persisted to a local database, enabling offline-first use cases by default.
Even though a GraphQL API is already added to your project, the cloud synchronization will only be enabled when the API plugin is initialized and the backend provisioned. See the Next steps for more info.
Writing to the databaseTo write to the database, create an instance of the Post model and save it.
To read from the database, the simplest approach is to query for all records of a given model type.
Next stepsCongratulations! Youâve created and retrieved data from the local database. Check out the following links to see other Amplify DataStore use cases and advanced concepts:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4