Repository navigation
docs(v2.4): backport docs for PRs cherry-picked into release/2.4 - #2445
Merged
Merged
Conversation
…y with DECIMAL columns) Restores 9058c8d, excluded in 513e63d. It documents spiceai/spiceai#15082, which release/2.4 now contains (v2.4.0).
…y shared-state feature) Restores 66ab1e4, excluded in 513e63d. It documents spiceai/spiceai#15135, which release/2.4 now contains (v2.4.0).
…s; deprecate top-level snapshots and runtime.scheduler state settings) Restores 5213944, excluded in 513e63d. It documents spiceai/spiceai#15136, which release/2.4 now contains (v2.4.0).
…nd async job cleanup timing) Restores f443ab6, excluded in 513e63d. It documents spiceai/spiceai#15199, which release/2.4 now contains (v2.4.0).
Restores f65269c, excluded in 513e63d. It documents spiceai/spiceai#15241, which release/2.4 now contains (v2.4.0).
…flict and cleanup metrics) Restores c01cc01, excluded in 513e63d. It documents spiceai/spiceai#15203, which release/2.4 now contains (v2.4.0).
…lease on graceful shutdown) Restores 94b3239, excluded in 513e63d. It documents spiceai/spiceai#15256, which release/2.4 now contains (v2.4.0).
…r its old heartbeat to lapse, then registers) Restores f7c360b, excluded in 513e63d. It documents spiceai/spiceai#15196, which release/2.4 now contains (v2.4.0).
…t metrics, Datadog pod panels) Restores af5309a except reference/spicepod/runtime.md. It documents spiceai/spiceai#15310, #15212, #15309, which release/2.4 now contains (v2.4.0). The query-interactive pool (spiceai/spiceai#15144) is not in release/2.4 and stays out; the cayenne/index.md change (#15340) was already kept in 513e63d. Snapshot pinning (spiceai/spiceai#15221) is not in release/2.4, so the conflicting lines take trunk's wording, which no longer mentions it.
Restores the /v1/search part of 249d7ea. It documents spiceai/spiceai#15119, which release/2.4 now contains (v2.4.0). The task-history change for async queries (spiceai/spiceai#15213) is not in release/2.4 and stays out.
…thread) Restores the JSON function and MySQL binlog parts of 223a66e. It documents spiceai/spiceai#15078 and #15181, which release/2.4 now contains (v2.4.0). The Parquet page-size bound (#15321), Docker /tmp (#15245), and GraphQL retry warnings (#15255) are not in release/2.4 and stay out.
Backports the cayenne_compaction_max_files_per_pick changes from 0a9ef6d. They document spiceai/spiceai#15227, which release/2.4 contains (v2.4.0). Scan-view reuse under target_freshness (spiceai/spiceai#15259) is not in release/2.4 and stays out; the caching and Iceberg parts of 0a9ef6d are already in version-2.4.x.
… served before their first refresh) Backports the append readiness changes from 6a82bb9. They document spiceai/spiceai#15463, which release/2.4 contains (v2.4.0). The tool-call limit (#15353), Cloud default region (#15414), env store precedence (#15469), and accelerated views (#15371) are not in release/2.4 and stay out.
…d-refresh fails and retries) Backports the refresh stall section from 7df4ed2. It documents spiceai/spiceai#15457, which release/2.4 contains (v2.4.0). The SMB port (#15502), compressed HTTP responses (#15327), DynamoDB numbers (#15513), and URL table checks (#15354) are not in release/2.4 and stay out.
…pshot download failures) Backports two of the five changes in 0e1cc95. They document spiceai/spiceai#15496 (non-Cayenne acceleration engines and the DuckDB vector engine are deprecated) and #15472 (a snapshot reader that cannot load a newer snapshot reports snapshot_download_failed), which release/2.4 contains (v2.4.0). Decimal division pushdown (#15512), the full-text index rebuild (#14954), and MySQL CDC column type changes (#15134) are not in release/2.4 and stay out.
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The refresh guide claims query-priority isolation from an upstream change explicitly excluded from v2.4.
1 open issue
What changed in this PR
Backports documentation for features shipped in v2.4.0, updating the versioned reference and operational guides after the original v2.4 snapshot.
Changes:
- Documents snapshot configuration, retention, recovery, shared state, and instance identity.
- Adds accelerator deprecation guidance and updates refresh, replication, and compaction behavior.
- Updates SQL behavior, search request documentation, and monitoring details.
All paths below are relative to website/versioned_docs/version-2.4.x/.
| File | Description |
|---|---|
reference/sql/select.md |
Corrects spelling and grammar. |
reference/sql/json.md |
Clarifies partial query pushdown. |
reference/sql/index.md |
Documents fractional-literal decimal conversions. |
reference/spicepod/runtime.md |
Updates shared state, identity, metrics, and migration guidance. |
reference/spicepod/index.md |
Marks top-level snapshot settings deprecated. |
reference/spicepod/datasets.md |
Documents per-dataset snapshot overrides. |
monitoring/datadog/index.md |
Clarifies grouping for Kubernetes health panels. |
features/observability/index.md |
Adds snapshot and state-store metrics. |
features/distributed-query/index.md |
Updates identity, shared-state configuration, and job cleanup. |
features/data-acceleration/snapshots.md |
Documents retention, migration, leases, and recovery. |
features/data-acceleration/refresh-modes/snapshot.md |
Updates reader configuration, failures, and notifications. |
features/data-acceleration/refresh-modes/append.md |
Updates readiness after snapshot restoration. |
features/data-acceleration/data-refresh.md |
Updates readiness, snapshot polling, and stalled-refresh handling. |
features/cdc/postgres-replication.md |
Documents identity changes and abandoned-slot cleanup. |
features/cdc/mysql-replication.md |
Documents the dedicated binlog reader thread. |
deployment/read-write-separation.md |
Updates snapshot retention and storage sizing. |
components/vectors/index.md |
Marks DuckDB vectors deprecated. |
components/vectors/duckdb.md |
Adds Cayenne migration guidance. |
components/data-accelerators/turso.md |
Adds deprecation and migration guidance. |
components/data-accelerators/sqlite/index.md |
Adds deprecation guidance and recommends Cayenne. |
components/data-accelerators/postgres/index.md |
Adds deprecation and migration guidance. |
components/data-accelerators/index.md |
Marks non-Cayenne engines deprecated. |
components/data-accelerators/duckdb/index.md |
Adds deprecation and migration guidance. |
components/data-accelerators/cayenne/performance.md |
Clarifies append-only compaction sizing. |
components/data-accelerators/cayenne/index.md |
Updates subset-compaction eligibility and limits. |
components/data-accelerators/arrow/index.md |
Adds deprecation guidance and Windows migration constraints. |
cli/reference/query.md |
Updates scheduler state configuration guidance. |
api/HTTP/post-search.RequestSchema.json |
Documents the non-whitespace search-text requirement. |
api/HTTP/post-search.api.mdx |
Updates embedded search API documentation. |
Review effort: Balanced
Contributor
|
🚀 deployed to https://e6fca893.spiceai-org-website.pages.dev |
lukekim
approved these changes
Oct 27, 2026
sgrebnov
approved these changes
Oct 27, 2026
krinart
enabled auto-merge (squash)
October 27, 2026 18:48
lukekim
disabled auto-merge
October 27, 2026 19:04
This branch was successfully deployed
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.
Brings
version-2.4.xin line with what shipped in v2.4.0 (release/2.4at78a47787ef).Most of the spiceai/spiceai PRs that #2414 left out of the 2.4.x docs were cherry-picked into
release/2.4on 2026-10-23 and 2026-10-24. Several trunk docs commits from after the snapshot also document PRs that are in v2.4.0. Each commit backports one trunk docs commit, and its message names the spiceai/spiceai PRs it covers and the parts it leaves out.Restored from the #2414 exclusions:
9058c8da(spiceai/spiceai#15082),66ab1e4e(spiceai/spiceai#15135),52139445(spiceai/spiceai#15136),f443ab63(spiceai/spiceai#15199),f65269c0(spiceai/spiceai#15241),c01cc016(spiceai/spiceai#15203),94b3239b(spiceai/spiceai#15256),f7c360b5(spiceai/spiceai#15196), andaf5309a4(spiceai/spiceai#15310, spiceai/spiceai#15212, spiceai/spiceai#15309).223a66e4(spiceai/spiceai#15078, spiceai/spiceai#15181) and249d7eac(spiceai/spiceai#15119) are restored in part.Partial backports of later commits:
0e1cc953: non-Cayenne accelerators deprecated (feat: deprecate non-Cayenne acceleration engines and the DuckDB vector engine spiceai#15496),snapshot_download_failed(fix(snapshots): report a snapshot reader that cannot load a newer snapshot spiceai#15472)6a82bb96: append readiness with snapshots (fix: serve append accelerations with snapshots enabled while the source is down spiceai#15463)7df4ed2f: refresh stall (fix(acceleration): fail and retry a refresh whose source goes silent mid-stream spiceai#15457)0a9ef6d5: append-only compaction (perf(cayenne): compact an append-only table's small files without stalling its writers spiceai#15227)f5f3b977: typo fixesThe query-interactive pool (spiceai/spiceai#15144), cluster mTLS (spiceai/spiceai#15285), snapshot pinning (spiceai/spiceai#15221), and the other parts that commit messages name as left out stay out, because
release/2.4does not contain their PRs.Verification
release/2.4contains its merge commit or a cherry-pick of it (git merge-base --is-ancestor, or a(#N)commit onrelease/2.4).git apply -3. The two conflicts inaf5309a4took trunk's wording, which leaves out snapshot pinning.website/docs. Every remaining difference belongs to a PR thatrelease/2.4does not contain.release/2.4code. Other claims carry over from the trunk docs PRs and were not re-run against v2.4.0.npm ci && npm run buildata8d3ae81(onBrokenLinksandonBrokenAnchorsset tothrow) exits 0:[SUCCESS] Generated static files in "build".