docs(datasets): document on_schema_change schema-evolution policy#1842
Merged
Conversation
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://bbba7a95.spiceai-org-website.pages.dev |
lukekim
approved these changes
Jun 13, 2026
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
spiceai/spiceai#11261 wires up the dataset-level
on_schema_changepolicy (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 behaviorfailappend_new_columnssync_all_columnsVerified against
crates/spicepod/src/component/dataset.rs(top-level dataset field,#[serde(rename_all = "snake_case")], defaultBlock) andcrates/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 themode: file_updateescape 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 buildpasseswebsite/docs/reference/spicepod/datasets.md)