Sync from docs: add Convex as experimental source database (powersync-docs #456)#46
Open
bean1352 wants to merge 1 commit into
Open
Sync from docs: add Convex as experimental source database (powersync-docs #456)#46bean1352 wants to merge 1 commit into
bean1352 wants to merge 1 commit into
Conversation
- AGENTS.md: add Convex to preflight database list and Onboarding Playbook step 2 - powersync-service.md: add convex tag + Convex Quick Start section - sync-config.md: add convex tag + Convex-specific Sync Streams patterns section - custom-backend.md: add Convex write-path exception note
This file contains hidden or 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
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.
Source docs PR: powersync-ja/powersync-docs#456
What changed in docs
powersync-docs #456 adds comprehensive documentation for Convex as a new experimental source database, covering connection setup (deployment URL + deploy key), a required checkpoint table/mutation, polling-based replication via
document_deltas, client UUID ID mapping, Convex-specific Sync Streams patterns, and the Convex mutation write path.Skill updates in this PR
skills/powersync/AGENTS.md— added Convex to the preflight database list in the Do/Don't compliance table; added Convex as a named path in Onboarding Playbook step 2 (pointing to powersync-service.md § "Convex Quick Start" and noting no custom REST API needed for writes)skills/powersync/references/powersync-service.md— addedconvexto metadata tags; added Convex Quick Start section covering thepowersync_checkpointstable + mutation prerequisite, deploy key permission requirements, self-hosted service YAML (type: convex), client UUID ID mapping, polling latency, and the table-drop limitationskills/powersync/references/sync-config.md— addedconvexto metadata tags; added Convex-Specific Patterns section covering UUID ID mapping,Int64casting to SQLite integer, Convex Auth JWT subject extraction (substring(auth.user_id(), 1, 32)), and table name qualification, with a full exampleskills/powersync/references/custom-backend.md— added a Convex exception note in the Architecture Recap section clarifying that for Convex the write path uses Convex mutations directly (no REST API), and that Convex Auth requiresclient_auth.audience: [convex]Notes for reviewer
onboarding-custom.mdreference path was deliberately not modified — Convex does not fit the "custom REST backend" pattern and is now routed through the new Convex-specific bullet in AGENTS.md step 2.onboarding-supabase.md) is warranted in future, that would be a separate PR.sync/types.mdx(Id→text, Int64→text/INTEGER, Float64→real, Boolean→integer/0/1, Bytes→base64 text, Array/Object/Record→JSON text) is not reproduced in full in the skills — the Sync Streams example covers the actionable casting patterns an agent needs. If reviewers want the full table, it could be added to a dedicated Convex reference file.Generated by Claude Code