docs(ducklake): document ducklake_automatic_migration param#1931
Open
claudespice wants to merge 1 commit into
Open
docs(ducklake): document ducklake_automatic_migration param#1931claudespice wants to merge 1 commit into
claudespice wants to merge 1 commit into
Conversation
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://8f05cdd2.spiceai-org-website.pages.dev |
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
Both DuckLake pages (data connector and catalog) omit the real, user-facing
ducklake_automatic_migrationparameter. The Limitations note on each page already tells readers that "older DuckLake catalogs require a metadata migration before use" but never names the knob that performs it, leaving no documented way to act on the limitation.What the code does: both the DuckLake data connector and catalog connector declare
ParameterSpec::component("automatic_migration")(auto-prefixed toducklake_automatic_migration), defaultfalse, parsed as a boolean (eq_ignore_ascii_case("true")) and passed through tobuild_ducklake_attach_sql. Whentrue, an older catalog schema is migrated to the version required by the DuckLake extension on attach; the migration rewrites catalog metadata and cannot be undone.What changed: added a
ducklake_automatic_migrationrow to theparamstable on both pages, and updated the migration Limitations bullet to reference the parameter.Net-new parameter (absent from v2.1.0 and v2.0.1) → vNext (
website/docs/) only; no versioned-docs propagation.Source
spiceai/spiceai@trunk(3f710af):crates/data-connectors/connector-ducklake/src/lib.rs:168(ParameterSpec),:341-346(consume, default false),:290(wired intobuild_ducklake_attach_sql)crates/runtime/src/catalogconnector/ducklake.rs:72(ParameterSpec),:201-204,:333Test plan
cd website && npm run buildpasses