Skip to content

docs(datasets): document on_schema_change schema-evolution policy#1842

Merged
lukekim merged 1 commit into
trunkfrom
docs-on-schema-change
Jun 13, 2026
Merged

docs(datasets): document on_schema_change schema-evolution policy#1842
lukekim merged 1 commit into
trunkfrom
docs-on-schema-change

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

spiceai/spiceai#11261 wires up the dataset-level on_schema_change policy (the config was added in #10908 but previously unwired). Accelerated datasets can now evolve their schema in place for lossless, widening-compatible source changes instead of failing the refresh. This adds a reference section for the field in the dataset spec — it was undocumented (only mentioned in release notes).

Documents the four policy values verified against source:

  • block (default) — OnSchemaChange::Block, preserves historical behavior
  • fail
  • append_new_columns
  • sync_all_columns

Verified against crates/spicepod/src/component/dataset.rs (top-level dataset field, #[serde(rename_all = "snake_case")], default Block) and crates/runtime/src/init/dataset.rs (accelerated-datasets-only; non-accelerated datasets warn and treat it as inert). Engine support (DuckDB/SQLite/Turso/Cayenne in place; others degrade on restart) and the mode: file_update escape hatch are documented per the PR's implementation notes.

Addition → vNext only (website/docs/); older versions don't have the wired feature.

Source PRs

Test plan

  • cd website && npm run build passes
  • Versioned-docs propagation: addition, vNext only — no versioned copies
  • Files updated: 1 (website/docs/reference/spicepod/datasets.md)

@github-actions

github-actions Bot commented Jun 13, 2026

Copy link
Copy Markdown

✅ 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

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

@lukekim lukekim merged commit 0af1d2b into trunk Jun 13, 2026
8 of 11 checks passed
@lukekim lukekim deleted the docs-on-schema-change branch June 13, 2026 16:09
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