docs: update overview and installation with PowerSync collection reference#1362
docs: update overview and installation with PowerSync collection reference#1362devagrawal09 wants to merge 1 commit intoTanStack:mainfrom
Conversation
…rence Made-with: Cursor
|
📝 WalkthroughWalkthroughDocumentation updates adding PowerSync integration guidance to installation and overview sections. Includes setup instructions, usage examples, supported platforms, and configuration details alongside existing sync options like ElectricSQL. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/installation.md`:
- Around line 102-105: The install snippet currently shows a Web-only command
(npm install `@tanstack/powersync-db-collection` `@powersync/web`
`@journeyapps/wa-sqlite`) while the text claims multi-platform support; split the
installation instructions into platform-specific subsections (Web, React Native,
Node.js) and provide the correct package sets for each (Web: `@powersync/web` +
`@journeyapps/wa-sqlite`, React Native: `@powersync/react-native` with adapters like
`@powersync/op-sqlite` or `@journeyapps/react-native-quick-sqlite`, Node.js:
`@powersync/node` with better-sqlite3), or explicitly scope this section to Web
only and update the descriptive text that references powerSyncCollectionOptions
and the PowerSync Collection docs to avoid implying the single install line
works for all platforms.
In `@docs/overview.md`:
- Line 522: The backend list in the overview sentence "PowerSync provides
offline-first sync with a SQLite-based local database and real-time
synchronization with PostgreSQL, MongoDB, MySQL, and SQL Server backends" should
include maturity tier qualifiers or be aligned with docs/installation.md; update
that sentence to either append qualifiers (e.g., "PostgreSQL (GA), MongoDB (GA),
MySQL (Beta), SQL Server (Alpha)") or remove SQL Server from the list to match
installation.md so the documentation is consistent and accurate.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 98b82408-122f-44fe-a0d5-ab3e2545540b
📒 Files selected for processing (2)
docs/installation.mddocs/overview.md
| npm install @tanstack/powersync-db-collection @powersync/web @journeyapps/wa-sqlite | ||
| ``` | ||
|
|
||
| Use `powerSyncCollectionOptions` to sync data via PowerSync's SQLite-based database with real-time synchronization to PostgreSQL, MongoDB, and MySQL backends. Supports Web, React Native, and Node.js. See the [PowerSync Collection documentation](./collections/powersync-collection.md) for setup details. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
What are the officially recommended npm packages for PowerSync on Web, React Native, and Node.js (March 2026), and is @journeyapps/wa-sqlite required on all platforms?
💡 Result:
Officially recommended npm packages (PowerSync docs, as of March 2026)
Web (browser)
@powersync/web- Peer dependency (required):
@journeyapps/wa-sqlite(the Web SDK “currently requires” it) [1]
React Native / Expo
@powersync/react-native[2]- SQLite adapter (choose one):
- Recommended:
@powersync/op-sqliteplus its peer@op-engineering/op-sqlite[2] - Alternative / “original” adapter:
@journeyapps/react-native-quick-sqlite[2] - Expo Go: use JS adapter
@powersync/adapter-sql-js(because the native adapters aren’t compatible with Expo Go) [2]
- Recommended:
Node.js
@powersync/node[3]- Recommended SQLite driver:
better-sqlite3[3] (and PowerSync notes the older@powersync/better-sqlite3fork is “no longer recommended” for@powersync/node≥0.12.0) [3]
Is @journeyapps/wa-sqlite required on all platforms?
No—it’s required for the Web SDK, but not for React Native (which uses native/JS adapters like OP-SQLite / Quick SQLite / sql.js) [2], and not for Node.js (which uses drivers like better-sqlite3) [3]. [1]
Sources: Web SDK docs [1], React Native & Expo docs [2], Node.js SDK docs [3].
Install command is Web-only but documentation claims multi-platform support.
The listed packages are Web-specific: @powersync/web requires @journeyapps/wa-sqlite, but React Native uses @powersync/react-native (with adapters like @powersync/op-sqlite or @journeyapps/react-native-quick-sqlite) and Node.js uses @powersync/node (with better-sqlite3). Separate install commands by platform or scope this section to Web only to prevent setup failures.
Suggested doc adjustment
- npm install `@tanstack/powersync-db-collection` `@powersync/web` `@journeyapps/wa-sqlite`
+ # Web
+ npm install `@tanstack/powersync-db-collection` `@powersync/web` `@journeyapps/wa-sqlite`
+
+ # React Native
+ npm install `@tanstack/powersync-db-collection` `@powersync/react-native` `@powersync/op-sqlite` `@op-engineering/op-sqlite`
+
+ # Node.js
+ npm install `@tanstack/powersync-db-collection` `@powersync/node` better-sqlite3- Supports Web, React Native, and Node.js.
+ Web example shown above. React Native and Node.js require platform-specific PowerSync packages and SQLite adapters—see PowerSync docs for details.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| npm install @tanstack/powersync-db-collection @powersync/web @journeyapps/wa-sqlite | |
| ``` | |
| Use `powerSyncCollectionOptions` to sync data via PowerSync's SQLite-based database with real-time synchronization to PostgreSQL, MongoDB, and MySQL backends. Supports Web, React Native, and Node.js. See the [PowerSync Collection documentation](./collections/powersync-collection.md) for setup details. | |
| # Web | |
| npm install `@tanstack/powersync-db-collection` `@powersync/web` `@journeyapps/wa-sqlite` | |
| # React Native | |
| npm install `@tanstack/powersync-db-collection` `@powersync/react-native` `@powersync/op-sqlite` `@op-engineering/op-sqlite` | |
| # Node.js | |
| npm install `@tanstack/powersync-db-collection` `@powersync/node` better-sqlite3 |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/installation.md` around lines 102 - 105, The install snippet currently
shows a Web-only command (npm install `@tanstack/powersync-db-collection`
`@powersync/web` `@journeyapps/wa-sqlite`) while the text claims multi-platform
support; split the installation instructions into platform-specific subsections
(Web, React Native, Node.js) and provide the correct package sets for each (Web:
`@powersync/web` + `@journeyapps/wa-sqlite`, React Native: `@powersync/react-native`
with adapters like `@powersync/op-sqlite` or
`@journeyapps/react-native-quick-sqlite`, Node.js: `@powersync/node` with
better-sqlite3), or explicitly scope this section to Web only and update the
descriptive text that references powerSyncCollectionOptions and the PowerSync
Collection docs to avoid implying the single install line works for all
platforms.
|
|
||
| ### 3. PowerSync sync | ||
|
|
||
| [PowerSync](https://powersync.com) provides offline-first sync with a SQLite-based local database and real-time synchronization with PostgreSQL, MongoDB, MySQL, and SQL Server backends. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Does PowerSync currently support real-time sync for SQL Server alongside PostgreSQL, MongoDB, and MySQL, and should docs list all four for the TanStack PowerSync collection integration?
💡 Result:
Yes—PowerSync does support SQL Server as a source database, but it’s currently labeled alpha (while MySQL is beta) and SQL Server replication has inherent CDC-driven latency compared to Postgres logical replication / MySQL binlog approaches. [1][2]
So for the TanStack PowerSync collection integration docs, it would be reasonable to list all four backends if you also qualify maturity, e.g. “PostgreSQL, MongoDB, MySQL (beta), SQL Server (alpha)”. Right now the TanStack page lists only PostgreSQL, MongoDB and MySQL. [3]
Sources
[1] PowerSync Pricing (supported backend DBs incl. MySQL beta, SQL Server alpha) (powersync.com)
[2] PowerSync Docs – SQL Server source DB setup (CDC latency note) (docs.powersync.com)
[3] TanStack DB Docs – PowerSync Collection (mentions PostgreSQL, MongoDB, MySQL) (tanstack.com)
Citations:
- 1: https://www.powersync.com/pricing
- 2: https://docs.powersync.com/installation/database-setup
- 3: https://tanstack.com/db/latest/docs/collections/powersync-collection
Add maturity tier qualifiers to backend list for accuracy.
The overview.md line includes SQL Server alongside PostgreSQL, MongoDB, and MySQL. While PowerSync does support SQL Server, it's currently in alpha status (MySQL is beta, others GA). If SQL Server is listed here, either clarify its alpha status or align the backend list with docs/installation.md to ensure consistent guidance across documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/overview.md` at line 522, The backend list in the overview sentence
"PowerSync provides offline-first sync with a SQLite-based local database and
real-time synchronization with PostgreSQL, MongoDB, MySQL, and SQL Server
backends" should include maturity tier qualifiers or be aligned with
docs/installation.md; update that sentence to either append qualifiers (e.g.,
"PostgreSQL (GA), MongoDB (GA), MySQL (Beta), SQL Server (Alpha)") or remove SQL
Server from the list to match installation.md so the documentation is consistent
and accurate.
2 participants
🎯 Changes
Updates docs/overview.md and docs/installation.md to reference the PowerSync Collection documentation for full setup details including schema validation, type transformations, and advanced transactions.
✅ Checklist
pnpm test.🚀 Release Impact
Summary by CodeRabbit