Skip to content

Custom Checkpoint Request Rollout Docs - #614

Merged
benitav merged 10 commits into
mainfrom
custom-checkpoints-rollout-docs
Sep 10, 2026
Merged

Custom Checkpoint Request Rollout Docs#614
benitav merged 10 commits into
mainfrom
custom-checkpoints-rollout-docs

Conversation

@stevensJourney

Copy link
Copy Markdown
Contributor

Existing users of custom write checkpoints will most likely need to upgrade to custom checkpoint requests in the future. During an upgrade, developers will probably need to simultaneously cater for older applications which still use legacy custom write checkpoints and newer applications which use checkpoint requests.

On the PowerSync service side, the behaviour for the two share quite a lot of implementation. The main difference is that the newer checkpoint requests are temporary - they are deleted after a period. This is fine since those requests are retried by the client. Legacy write checkpoints are not temporary, they should not be deleted.

The PowerSync service needs some manner to distinguish between the two checkpoint events. This adds docs for that and some general recommendations for rolling out an upgrade to checkpoint_requests.

For context of limitations and implementations, see:

AI usage: These docs were generated with the help of Codex 5.6.

@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
powersync 🟢 Ready View Preview Sep 10, 2026, 11:03 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
@claude

claude Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Vale and mintlify link-check results weren't available to this review, so terminology/spelling/link findings from those tools aren't covered here — the comments above focus on technical accuracy and content.

Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
Comment thread handling-writes/custom-write-checkpoints.mdx Outdated
stevensJourney and others added 3 commits September 9, 2026 16:15
Co-authored-by: benitav <benitav@users.noreply.github.com>
Co-authored-by: benitav <benitav@users.noreply.github.com>
Co-authored-by: benitav <benitav@users.noreply.github.com>
@benitav

benitav commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

I used this PR to make some other (somewhat related) updates, FYI:

  • made clear that storage v4 is not available for postgres bucket storage where relevant
  • I restructured the Data Pipelines page according to our writing and style standards - with these new custom checkpoints the flow felt quite "choppy".
  • I updated the sync rules code example to sync streams
  • I added min. SDK version numbers for checkpoint request API

AI usage: Claude Code assisted with the grunt work here.

@benitav
benitav merged commit 587f0a5 into main Sep 10, 2026
6 checks passed
@benitav
benitav deleted the custom-checkpoints-rollout-docs branch September 10, 2026 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants