From 9b96d6cbc319aa722f425488b0395383fc344ab0 Mon Sep 17 00:00:00 2001 From: claudespice Date: Wed, 15 Jul 2026 01:24:25 -0700 Subject: [PATCH] docs(ducklake): document ducklake_automatic_migration param --- website/docs/components/catalogs/ducklake.md | 3 ++- website/docs/components/data-connectors/ducklake.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/components/catalogs/ducklake.md b/website/docs/components/catalogs/ducklake.md index ec1820d00..d21791787 100644 --- a/website/docs/components/catalogs/ducklake.md +++ b/website/docs/components/catalogs/ducklake.md @@ -80,6 +80,7 @@ The `access` field controls what operations are allowed on the catalog: | `ducklake_aws_secret_access_key` | Optional. The AWS secret access key for S3 storage. Must be set together with `ducklake_aws_access_key_id`. | | `ducklake_aws_endpoint` | Optional. Custom S3-compatible endpoint URL (e.g., for MinIO). | | `ducklake_aws_allow_http` | Optional. Set to `true` to allow HTTP (non-TLS) connections to S3. Default: `false`. | +| `ducklake_automatic_migration` | Optional. Set to `true` to automatically migrate an older DuckLake catalog schema to the version required by the DuckLake extension on attach. Default: `false`. Migration rewrites catalog metadata and **cannot be undone**. | ## Authentication @@ -198,7 +199,7 @@ Spice integrates with multiple secret stores to help manage sensitive data secur :::warning[Limitations] -- Spice uses DuckDB 1.5.3, which supports DuckLake 1.0. Older DuckLake catalogs require a metadata migration before use. See [DuckLake migration guide](https://ducklake.select/docs/stable/duckdb/guides/troubleshooting#connecting-to-an-older-ducklake). +- Spice uses DuckDB 1.5.3, which supports DuckLake 1.0. Older DuckLake catalogs require a metadata migration before use — set `ducklake_automatic_migration: true` to perform it on attach (this rewrites catalog metadata and cannot be undone). See [DuckLake migration guide](https://ducklake.select/docs/stable/duckdb/guides/troubleshooting#connecting-to-an-older-ducklake). - The DuckLake DuckDB extension is downloaded at runtime on first use, requiring network connectivity. - The `information_schema` and `pg_catalog` system schemas are automatically filtered out during discovery. - Catalog refresh is non-incremental — a full re-query of `information_schema` is performed on each refresh cycle. diff --git a/website/docs/components/data-connectors/ducklake.md b/website/docs/components/data-connectors/ducklake.md index 893255b16..6d6024b61 100644 --- a/website/docs/components/data-connectors/ducklake.md +++ b/website/docs/components/data-connectors/ducklake.md @@ -61,6 +61,7 @@ The dataset name cannot be a [reserved keyword](../../reference/spicepod/keyword | `ducklake_aws_secret_access_key` | Optional. The AWS secret access key for S3 storage. Must be set together with `ducklake_aws_access_key_id`. | | `ducklake_aws_endpoint` | Optional. Custom S3-compatible endpoint URL (e.g., for MinIO). | | `ducklake_aws_allow_http` | Optional. Set to `true` to allow HTTP (non-TLS) connections to S3. Default: `false`. | +| `ducklake_automatic_migration` | Optional. Set to `true` to automatically migrate an older DuckLake catalog schema to the version required by the DuckLake extension on attach. Default: `false`. Migration rewrites catalog metadata and **cannot be undone**. | ### Connection string formats @@ -201,7 +202,7 @@ datasets: :::warning[Limitations] -- Spice uses DuckDB 1.5.3, which supports DuckLake 1.0. Older DuckLake catalogs require a metadata migration before use. See [DuckLake migration guide](https://ducklake.select/docs/stable/duckdb/guides/troubleshooting#connecting-to-an-older-ducklake). +- Spice uses DuckDB 1.5.3, which supports DuckLake 1.0. Older DuckLake catalogs require a metadata migration before use — set `ducklake_automatic_migration: true` to perform it on attach (this rewrites catalog metadata and cannot be undone). See [DuckLake migration guide](https://ducklake.select/docs/stable/duckdb/guides/troubleshooting#connecting-to-an-older-ducklake). - The DuckLake DuckDB extension is downloaded at runtime on first use, requiring network connectivity. - The `ducklake_connection_string` parameter is required — unlike the catalog connector, it cannot be omitted. - Each dataset creates its own DuckDB connection pool. For querying many tables from the same catalog, consider using the [DuckLake Catalog Connector](../catalogs/ducklake) instead, which shares a single connection pool.