Skip to content

docs: document DuckLake as a DuckDB connection type#693

Open
sdolidze wants to merge 1 commit into
mainfrom
docs/ducklake-connection-type-v2
Open

docs: document DuckLake as a DuckDB connection type#693
sdolidze wants to merge 1 commit into
mainfrom
docs/ducklake-connection-type-v2

Conversation

@sdolidze
Copy link
Copy Markdown
Contributor

Summary

Documents DuckLake as a second connection type for DuckDB project connections, alongside the existing MotherDuck mode. The setup tile is renamed from "MotherDuck" to "DuckDB", and the connection type is chosen from a MotherDuck / DuckLake toggle inside the form.

DuckLake combines any supported catalog backend (PostgreSQL, SQLite, DuckDB file) with any supported data path (S3-compatible, GCS, Azure Blob Storage, or local filesystem) to query Parquet data through DuckDB.

Upstream code change: lightdash/lightdash#23446.

Changes

  • Renamed the warehouse-list card from MotherDuck to DuckDB so it matches the new project-connection tile label.
  • Split the ### DuckDB section into a shared intro plus #### MotherDuck and #### DuckLake subsections. MotherDuck content is unchanged.
  • Added a full DuckLake reference: schema, catalog alias, catalog backends (PostgreSQL / SQLite / DuckDB file), data-path backends (S3-compatible / GCS / Azure / local), threads, and start of week.
  • Added a single-pod warning for SQLite and DuckDB-file catalogs (and the local data path), since those rely on the Lightdash server's local filesystem.
  • Added two profiles.yml examples: PostgreSQL + S3 (three-secret pattern with the ducklake: attach form) and SQLite + local data path (inline ducklake:sqlite: attach form).

Layout

### DuckDB                             ← shared intro + dbt-version note
  #### MotherDuck                      ← unchanged content, now a subsection
    Database / Schema / Token / Threads / Start of week / profiles.yml
  #### DuckLake                        ← new
    Schema / Catalog alias
    Catalog backend  → Postgres | SQLite | DuckDB file
    Data path backend → S3 | GCS | Azure | Local
    Threads / Start of week
    profiles.yml: Postgres+S3, SQLite+Local

Context

This supersedes #692 (the earlier auto-generated version), which labelled the tile MotherDuck / DuckLake. The actual frontend change renames the tile to DuckDB and moves the mode toggle inside the form, so this version matches the shipped UI.

Test plan

  • Run mintlify dev and confirm the ### DuckDB section renders with the two subsections and both fenced YAML examples.
  • Verify the DuckDB card on the warehouse list anchors to #duckdb.

🤖 Generated with Claude Code

Restructure the DuckDB section to cover both MotherDuck and DuckLake
modes. Adds catalog backend (Postgres / SQLite / DuckDB file) and data
path backend (S3 / GCS / Azure / local) field descriptions, plus dbt
profile examples for the two most common DuckLake shapes.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026

🤖 Documentation Bot

Status

⚠️ 1 broken link needs manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 timezones-draft.mdx

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview May 22, 2026, 2:54 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant