Support auto-initializing DuckLake#235
Merged
staticlibs merged 1 commit intoduckdb:mainfrom May 30, 2025
Merged
Conversation
There is a usability gap with using DuckLake with JDBC, when a connection must be opened first and then the following statement must be executed: ``` ATTACH 'ducklake:...' ``` Executing this additional `ATTACH` step, when accessing DuckLake from GUI tools or from high-level engines like Spark, is cumbersome and may require non-trivial configuration. This change adds two new connection properties: 1. `ducklake`: the `database-path` parameter to pass to `ATTACH '<database-path>'`. Value examples: ``` /path/to/lake1.db sqlite:/path/to/lake1.db postgres:postgresql://user:pwd@127.0.0.1:5432/lake1 ``` If `ducklake:` prefix to the value of this option is not specified - it is added automatically. Before running the `ATTACH` it also runs: ``` INSTALL ducklake LOAD ducklake ``` 2. `ducklake_alias`: the `database-alias` parameter to pass to `ATTACH '<database-path>' AS <database-alias>`. This is to allow to override auto-detected DuckLake catalog name in cases when `database-path` has long naming or include UUIDs. After the connection is established it also runs `USE <database-alias>`. Testing: test coverage is pending, DuckLake extension is not yet available in the `main` branch.
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
1 participant
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.
There is a usability gap with using DuckLake with JDBC, when a connection must be opened first and then the following statement must be executed:
Executing this additional
ATTACHstep, when accessing DuckLake from GUI tools or from high-level engines like Spark, is cumbersome and may require non-trivial configuration.This change adds two new connection properties:
ducklake: thedatabase-pathparameter to pass toATTACH '<database-path>'.Value examples:
If
ducklake:prefix to the value of this option is not specified - it is added automatically.Before running the
ATTACHit also runs:ducklake_alias: thedatabase-aliasparameter to pass toATTACH '<database-path>' AS <database-alias>.This is to allow to override auto-detected DuckLake catalog name in cases when
database-pathhas long naming or include UUIDs.After the connection is established it also runs
USE <database-alias>.Testing: test coverage is pending, DuckLake extension is not yet available in the
mainbranch.