AWS appsync migration guide #872
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-app-services ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
cbullinger
approved these changes
Jan 27, 2025
There was a problem hiding this comment.
Not sure if it's intentional while you're working on these guides, but this page is only accessible through the URL -- it isn't accessible through the Device Sync Deprecation option in the left nav menu
source/sync/migration/awsappsync.txt
Outdated
| - Device Sync APIs send changes to Atlas App Services. | ||
| - Atlas App Services performs any necessary conflict resolution, stores the changes | ||
| in Atlas, and syncs the changes to the other devices. | ||
| - Device Sync APIs updates the data in each device’s local realm. |
There was a problem hiding this comment.
Suggested change
| - Device Sync APIs updates the data in each device’s local realm. | |
| - Device Sync APIs update the data in each device’s local realm. |
source/sync/migration/awsappsync.txt
Outdated
| .. image:: /images/migration/device_sync_architecture.png | ||
| :alt: A diagram showing a typical Device Sync architecture. | ||
|
|
||
| In this architecture, your app uses the Realm APIs to communicate directly with |
There was a problem hiding this comment.
should this be uses the Atlas Device Sync APIs?
source/sync/migration/awsappsync.txt
Outdated
| - Use AWS Event Bridge to listen for event triggers from Atlas | ||
| - Add a Database Trigger to Atlas | ||
|
|
||
| You will also change 2 parts of your client code: |
There was a problem hiding this comment.
Suggested change
| You will also change 2 parts of your client code: | |
| You will also need to change the following in your client code: |
source/sync/migration/awsappsync.txt
Outdated
Comment on lines
67
to
68
| - The local data store also changes from a Realm database to the default | ||
| datastore on the device (typically SQLite), or another one of your choice. |
There was a problem hiding this comment.
Suggested change
| - The local data store also changes from a Realm database to the default | |
| datastore on the device (typically SQLite), or another one of your choice. | |
| - Change the local datastore from a Realm database to the default | |
| datastore on the device (typically SQLite) or another of your choice. |
source/sync/migration/awsappsync.txt
Outdated
Comment on lines
65
to
66
| - Because AppSync uses GraphQL, you will use the AWS AppSync API to communicate | ||
| with it AppSync |
There was a problem hiding this comment.
Suggested change
| - Because AppSync uses GraphQL, you will use the AWS AppSync API to communicate | |
| with it AppSync | |
| - Because AppSync uses GraphQL, you need to use AWS AppSync APIs to access GraphQL endpoints from your application. |
| .. image:: /images/migration/aws_appsync_architecture.png | ||
| :alt: A diagram showing a typical Device Sync architecture. | ||
|
|
||
| Migration Steps |
There was a problem hiding this comment.
If these are truly "steps" (which they seem to be), can we change the bullets to numbered items?
| :titlesonly: | ||
| :hidden: | ||
|
|
||
| Migrate to AWS AppSync </sync/migration/awsappsync> | ||
|
|
||
| As of September 2024, Device Sync is deprecated for Atlas App Services. Device | ||
| Sync will reach end-of-life and be removed on **September 30, 2025**. If you |
There was a problem hiding this comment.
Can't suggest changes to the below line, but maybe update to specify ...you should migrate to one of the alternative solution providers listed below...?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
Staging Links
Reminder Checklist
Before merging your PR, make sure to check a few things.
Release Notes
Review Guidelines
REVIEWING.md