Skip to content

docs(ducklake): document ducklake_automatic_migration param#1931

Open
claudespice wants to merge 1 commit into
trunkfrom
claude/ducklake-automatic-migration-param
Open

docs(ducklake): document ducklake_automatic_migration param#1931
claudespice wants to merge 1 commit into
trunkfrom
claude/ducklake-automatic-migration-param

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

Both DuckLake pages (data connector and catalog) omit the real, user-facing ducklake_automatic_migration parameter. 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 to ducklake_automatic_migration), default false, parsed as a boolean (eq_ignore_ascii_case("true")) and passed through to build_ducklake_attach_sql. When true, 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_migration row to the params table 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 into build_ducklake_attach_sql)
    • crates/runtime/src/catalogconnector/ducklake.rs:72 (ParameterSpec), :201-204, :333

Test plan

  • cd website && npm run build passes
  • No versioned-docs propagation needed (param is vNext-only)
  • Files updated: 2 (both DuckLake page types)

@github-actions

github-actions Bot commented Jul 15, 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

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

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.

1 participant