Repository navigation
docs(persistence): remove stale on-demand initialRender restriction - #2285
Merged
Merged
Conversation
The guide said initialRender requires an eager Collection, which contradicted the on-demand section that #2263 added. Point the eager readiness rules at that section instead. Co-authored-by: Isaac <no-reply@databricks.com>
|
Contributor
|
Size Change: 0 B Total Size: 237 kB ℹ️ View Unchanged
|
Contributor
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Document readiness rules docs/guides/sqlite-persistence.md |
The guide replaces the eager-only restriction with guidance that on-demand Collections apply initialRender readiness rules separately to each query demand. |
Priority:
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other
Possibly related PRs
- TanStack/db#2263: Adds persisted on-demand
initialRendersupport and documents the per-demand SQLite settlement behavior described in this guide. - TanStack/db#2168: Documents the eager-only restriction that this change updates.
Suggested reviewers: jp-knj
Merge Risk: 
8be92
-
The guide now clearly distinguishes eager and on-demand readiness behavior and is safe to merge.
Pre-merge checks: 
-
Check name Status Explanation Title check The title "docs(persistence): remove stale on-demand initialRender restriction" names the main change. The PR removes the outdated statement that initialRender does not support syncMode 'on-demand' in… Description check The description covers the change and its motivation. It names the stale sentence, explains the contradiction with the on-demand section, and states the change touches only docs/guides/sqlite-persiste… 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: Title check
-
Explanation
The title "docs(persistence): remove stale on-demand initialRender restriction" names the main change. The PR removes the outdated statement that initialRender does not support syncMode 'on-demand' in the SQLite persistence guide. It is specific and matches the changeset, which is a one-line documentation edit.
Full details: Description check
-
Explanation
The description covers the change and its motivation. It names the stale sentence, explains the contradiction with the on-demand section, and states the change touches only docs/guides/sqlite-persistence.md with no code changes. The template's Oracle Coverage section is not addressed, and the checklist and Release Impact boxes are not ticked. For a docs-only change, the Release Impact choice 'docs/CI/dev-only (no release)' should be marked. The Oracle Coverage section needs a short note that explains why no oracle applies to this docs-only change.
Resolution
Mark the 'This change is docs/CI/dev-only (no release)' box in Release Impact. Add a brief Oracle Coverage note stating that this is a non-bug, docs-only change with no observable code behavior, so no coverage-map oracle applies. Tick the local test checklist item only if pnpm test was run.
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. (1 skipped: 1 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.
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.
The SQLite persistence guide still says that
initialRenderrequires an eager persisted Collection and does not supportsyncMode: 'on-demand'. That was true before #2263. Now the guide contradicts itself: the readiness section says that eager and on-demand Collections both supportinitialRender, and the "On-demand Collections offline" section explains how each query demand settles from SQLite.This PR replaces the stale sentence. The new text says that the rules above it apply to an eager Collection, and it links to the on-demand section. The change is in
docs/guides/sqlite-persistence.mdonly. It changes no code.This pull request and its description were written by Isaac.
Summary by CodeRabbit
initialRenderreadiness rules to the Collection, while on-demand Collections apply them separately to each query demand.initialRenderis supported with on-demand synchronization.