Repository navigation
docs(cayenne): refresh_append_overlap is supported from v2.2.1 - #2191
Merged
Merged
Conversation
spiceai/spiceai#13574 removed the load-time rejection and made Cayenne honor the overlap window; git tag --contains puts it in v2.2.1 only. #2186 dropped the limitation bullet from the vNext Cayenne page but left the same claim standing on reference/spicepod/datasets.md and views.md, which restate per-engine capability claims and are the usual miss for component-page-only fixes. - vNext datasets.md/views.md: claim removed - version-2.2.x: split by patch (v2.2.0 rejects, v2.2.1 supports) on the Cayenne limitations bullet and both reference pages - version-2.1.x and older left alone: the rejection is present at v2.1.5, v2.0.1, v1.11.6, v1.10.x and v1.9.x
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
1 similar comment
Contributor
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
Contributor
|
🚀 deployed to https://839405f0.spiceai-org-website.pages.dev |
lukekim
approved these changes
Sep 10, 2026
lukekim
approved these changes
Sep 11, 2026
4 tasks done
lukekim
pushed a commit
that referenced
this pull request
Sep 12, 2026
The version-2.3.x snapshot was cut on 2026-09-10, hours before #2191 retired the Cayenne refresh_append_overlap limitation, so the spicepod datasets and views references in it still tell readers the value fails to load under Cayenne. spiceai/spiceai removed the rejection in v2.2.1 and v2.3.0 honours the window like every other engine.
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.
Summary
Cayenne used to refuse to load a file-mode dataset that set
acceleration.refresh_append_overlap. spiceai/spiceai#13574 removed that rejection and made the engine honor the window;git tag --containsputs it inv2.2.1only.The rejection string tracks the change exactly:
not yet support refresh_append_overlapincrates/#2186 dropped the limitation bullet from the vNext Cayenne page — correctly — but the same claim is still standing on the two spicepod reference pages, which restate per-engine capability claims and are the standard miss for a component-page-only fix (the #1928 → #1940 shape). So
reference/spicepod/datasets.mdandviews.mdcurrently tell a vNext reader that a supported setting will fail their Spicepod to load:That is a false negative capability claim on a reference page — it reads as a limitation rather than a bug, so nothing flags it, and the reader's remedy is to not use a feature that works.
What changed
vNext — claim removed from:
website/docs/reference/spicepod/datasets.mdwebsite/docs/reference/spicepod/views.mdversion-2.2.x — the line splits mid-release, so it is documented per patch rather than flattened:
components/data-accelerators/cayenne/index.md— bullet retitled "Norefresh_append_overlapin v2.2.0", keeping the v2.2.0 error string and themode: memoryexemption, and adding that v2.2.1 supports the windowreference/spicepod/datasets.md,reference/spicepod/views.md— "Supported … from v2.2.1. In v2.2.0 a file-mode Cayenne dataset/view that sets this fails to load."version-2.1.x, 2.0.x, 1.11.x, 1.10.x, 1.9.x — untouched. Those releases really do reject it, so their pages are correct as they stand.
Behavior in v2.2.1
Not just "stops erroring" —
crates/runtime/tests/acceleration/cayenne_append_overlap.rsexists at v2.2.1 and covers both halves: the high-water mark is moved back by the configured duration so a late row is fetched, and the re-fetched rows inside the window are dropped by an exact-row comparison before the write rather than appended again. That is what the 2.2.x wording claims, and no more.Source refs
git tag --contains→v2.2.1crates/runtime/tests/acceleration/cayenne_append_overlap.rsat v2.2.1 —cayenne_append_refresh_honours_refresh_append_overlapcrates/accelerators/accelerator-cayenne/src/lib.rsat v2.2.0 — the release that still carries the rejectionOriginal documentation of the limitation: #2138.
Test plan
cd website && npm run buildpasses (#limitationsstill exists on the 2.2.x Cayenne page)grep -rln "Not supported by the Spice Cayenne" website/now returns only 2.1.x / 2.0.x / 1.11.x / 1.10.x / 1.9.x, all correct;grep -rn "Cayenne data accelerator does not yet support" website/leaves no vNext hit