Skip to content

Conversation

@vpetrovykh
Copy link
Contributor

I've tried different ways of writing up the details of how sync works. This is the format I've kinda landed on eventually:

  • not too much implementation details (so no exact steps for order of operations, for example); this is not an RFC
  • the details are split between properties, links, and link properties (as opposed to trying to split based on different stages of what sync is doing: insert, update, re-fetch)
  • I ended up grouping all the multi things together as a separate section because the basics are the same as for single links and props, but there's enough of a nuance that worth highlighting because of how multi fields can be modified instead of only ever being overwritten with new values.

I also ended up not using code snippets because that seemed to me like a lot of noise that was getting in the way of keeping explanations simple. Plus we have plenty of code examples elsewhere (like primers) that we could link to instead.

@github-actions
Copy link

github-actions bot commented Sep 8, 2025

Docs preview deploy

✅ Successfully deployed docs preview for commit 652c5c2:

https://edgedb-docs-plhpvdbul-edgedb.vercel.app

(Last updated: Sep 8, 2025, 16:46:20 UTC)

Copy link
Contributor

@aljazerzen aljazerzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As someone who did not know exactly how sync worked prior to reading this, I can say it explains the method well.

The first 2 or 3 sections are very understandable and the last 3 are details to the degree that I'd skip them until I actually needed them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants