Repository navigation
docs: anchor RC migration guidance to DB 0.9.2 - #2295
Merged
Merged
Conversation
|
Contributor
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Migration scope and API guidance docs/guides/migrate-to-1-0-rc.md, docs/guides/error-handling.md |
The guides identify the 0.9.2-to-1.0.0-rc.1 migration path and revise adapter, include, aggregate-validation, and error-handling migration guidance. |
Write, sync, and persistence guidance docs/guides/migrate-to-1-0-rc.md |
The migration guide revises direct-write and sync-adapter instructions, promotes persistence guidance, and removes earlier transaction-lifetime, package, and commit-turn instructions. |
Query, optional-feature, and SSR guidance docs/guides/migrate-to-1-0-rc.md, docs/collections/query-collection.md, docs/framework/react/overview.md, docs/guides/live-queries.md, docs/guides/ssr.md |
The guide adds optional pooling and storage guidance and removes earlier pooling and persisted-readiness sections. Related pages revise pagination, pooling, and SSR guidance. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Possibly related PRs
- TanStack/db#2235: Documents and implements the
useLiveInfiniteQuerypagination contract also described in this PR. - TanStack/db#2168: Introduces status, health, reload, cleanup, and error API changes covered by the migration guidance.
- TanStack/db#2171: Establishes the 1.0 RC migration baseline that this PR’s migration guide updates.
Suggested reviewers: tannerlinsley
Merge Risk: 
ce395
-
No actionable issue is established in the supplied documentation changes; they are mergeable subject to normal checks.
Pre-merge checks: 
-
Check name Status Explanation Description check The description follows the required template and clearly explains the documentation changes, oracle coverage, validation results, and release impact. The local pnpm test checkbox remains unchecked, b… Title check The title clearly summarizes the main change: anchoring RC migration guidance to the DB 0.9.2 baseline. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description follows the required template and clearly explains the documentation changes, oracle coverage, validation results, and release impact. The local pnpm test checkbox remains unchecked, but the documentation-only scope and other validation details are documented.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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 @coderabbitai help to get the list of available commands.
Contributor
|
Size Change: 0 B Total Size: 238 kB ℹ️ View Unchanged
|
More templates
@tanstack/angular-db
@tanstack/browser-db-sqlite-persistence
@tanstack/capacitor-db-sqlite-persistence
@tanstack/cloudflare-durable-objects-db-sqlite-persistence
@tanstack/convex-db-collection
@tanstack/db
@tanstack/db-ivm
@tanstack/db-sqlite-persistence-core
@tanstack/electric-db-collection
@tanstack/electron-db-sqlite-persistence
@tanstack/expo-db-sqlite-persistence
@tanstack/node-db-sqlite-persistence
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/preact-db
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/react-native-db-sqlite-persistence
@tanstack/react-router-with-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/tauri-db-sqlite-persistence
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
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.
🎯 Changes
The RC migration guide describes pooling as a change to existing behavior, although pooling did not exist in DB 0.9.2. Present pooling as a new, optional performance feature for screens with dozens or more live queries.
Compare migration instructions with the
@tanstack/db@0.9.2source tag. Remove instructions for intermediate persistence readiness aliases, health-node fields, direct sync transactions, and pooling helpers. Describe IndexedDB and network-first rendering as optional new features. Clarify that SSR adoption is optional and that its APIs already existed in 0.9.2.Keep actual upgrade requirements, including explicit mutation synchronization, hook dependency removal, status and health changes, and persistence adapter changes. Correct aggregate validation guidance and remove the claim that hooks previously ignored
getNextPageParam. The 0.9.2 hooks already rejected that option.🔬 Oracle Coverage
Documentation only. This PR changes no runtime behavior or oracle expectations.
✅ Checklist
pnpm test.git diff --checkpass.The full docs link check reports 51 existing failures in unchanged contributor documents. These include source links outside
/docsand JSON evidence links that the checker treats as Markdown paths.🚀 Release Impact
Follow-up to #2171.
Summary by CodeRabbit
getNextPageParamis unsupported and passing it at runtime throws an error.DbClientis optional.