Added 0900|Sync_With_Database.md #69
Conversation
docs/0900|Sync_With_Database.md
Outdated
| @@ -0,0 +1,106 @@ | |||
| ## Syncing to Database Recipie with Firebase | |||
|
|
|||
There was a problem hiding this comment.
The file name maps to the name of this page on the docs site. I think we should call this page Recipes so please rename the file to 0900|Recipes.md
There was a problem hiding this comment.
Changed the name to 0900|Recipes.md!
docs/0900|Sync_With_Database.md
Outdated
| @@ -0,0 +1,106 @@ | |||
| ## Syncing to Database Recipie with Firebase | |||
There was a problem hiding this comment.
I think this should just be Syncing to Firebase
There was a problem hiding this comment.
Changed to Syncing to Firebase
docs/0900|Sync_With_Database.md
Outdated
| @@ -0,0 +1,106 @@ | |||
| ## Syncing to Database Recipie with Firebase | |||
|
|
|||
| The example below shows a recipe for syncing Homebase with Firebase. To communicate with our backend we use the addTransactListener() method that is part of our useClient() API call. addTransactListener() takes in a function as a parameter. transactListener is the function that looks at all of our Datoms that have changed and updates them in Firebase. We also need a way to sync our backend data with Homebase. transactSilently() allows us to do exactly that and it is also part of the useClient() API call. We have a function called softTransact() which will take in a queue with all the changes that have been made in our database and use transactSilently() to notify Homebase of those changes. Debounced is used here to only improve performance as it allows us to wait for a certain number of changes to accumulate before updating Homebase. | |||
There was a problem hiding this comment.
This looks great! I've just made a few copy edits to trim it down a bit.
The example below shows a recipe for keeping Homebase React in sync with Firebase. client.addTransactListener(callback) lets you listen to every local transaction and send those updates to Firebase. We also need a way to sync Firebase with Homebase React. In this example we create a namespace on Firebase for each user based on their firebase uid and listen to all changes in that namespace. client.transactSilently(tx) allows us save changes received from Firebase without triggering our transactListener function and sending those changes back to Firebase endlessly.
Debounced is used here to improve performance as it allows us to batch changes that occur close together.
There was a problem hiding this comment.
Updated Description!
docs/0900|Sync_With_Database.md
Outdated
| const userId = currentUser.get('uid') | ||
| const transactListener = React.useCallback( | ||
| (changedDatoms) => { | ||
| const cardinalityManyAttrs = new Set([]) |
There was a problem hiding this comment.
Let's add a comment with some examples
const cardinalityManyAttrs = new Set([]) // E.g. ':project/todos' or ':user/friends'
docs/0900|Sync_With_Database.md
Outdated
| const transactListener = React.useCallback( | ||
| (changedDatoms) => { | ||
| const cardinalityManyAttrs = new Set([]) | ||
| const localOnlyAttrs = new Set([]) |
There was a problem hiding this comment.
const localOnlyAttrs = new Set([]) // E.g. ':current-user/uid' these are attributes you don't want to save to Firbase, but also don't want to have to call `client.transactSilently()` everytime you change them.
|
🎉 This PR is included in version 0.5.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
PR Description
Created a markdown file that shows an example of how you can sync data from Homebase to Firebase and from Firebase to Homebase.
PR Checklist
Testing
Docs
Typescript
Merging
For maintainers.
To merge, select "Squash and Merge". Then: