Skip to content

docs(cayenne): refresh_append_overlap is supported from v2.2.1 - #2191

Merged
lukekim merged 1 commit into
trunkfrom
fix/cayenne-append-overlap-now-supported
Sep 11, 2026
Merged

lukekim merged 1 commit into
trunkfrom
fix/cayenne-append-overlap-now-supported

Conversation

@claudespice

Copy link
Copy Markdown
Contributor

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 --contains puts it in v2.2.1 only.

The rejection string tracks the change exactly:

Tag not yet support refresh_append_overlap in crates/
v1.11.6, v2.0.1, v2.1.5, v2.2.0 present
v2.2.1, trunk gone

#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.md and views.md currently tell a vNext reader that a supported setting will fail their Spicepod to load:

Not supported by the Spice Cayenne (cayenne) acceleration engine: a file-mode Cayenne dataset that sets this fails 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.md
  • website/docs/reference/spicepod/views.md

version-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 "No refresh_append_overlap in v2.2.0", keeping the v2.2.0 error string and the mode: memory exemption, and adding that v2.2.1 supports the window
  • reference/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.rs exists 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

Original documentation of the limitation: #2138.

Test plan

  • cd website && npm run build passes (#limitations still exists on the 2.2.x Cayenne page)
  • Cross-page + cross-version sweep: 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
  • Files updated: 5

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
@github-actions

github-actions Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 deployed to https://839405f0.spiceai-org-website.pages.dev

@lukekim
lukekim merged commit 6624085 into trunk Sep 11, 2026
6 of 10 checks passed
@lukekim
lukekim deleted the fix/cayenne-append-overlap-now-supported branch September 11, 2026 15:51
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

1 active deployment
preview — f38aacef Deployed Sep 10, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants