Skip to content

Make reference for all ducklake functionsΒ #226

@MattDodsonEnglish

Description

@MattDodsonEnglish

Overall I've found the ducklake documentation very helpful, but I'm having a hard time finding and remembering functions. Besides that, it seems that the function parameters and returned table schemas are not always documented.

It would be nice to have a reference page (or collection of pages) to look up all functions in one place. Something with a repeated structure, like:

## <Function_name>

<Description and link to relevant guide page>

<Example>

<Params table>

<Return table>

The ducklake extension page on the DuckDB site is already a good start, but it seems to be missing functions (e.g. ducklake_cleanup_old_files() or ducklake.set_commit_message() ). Others do not have documented paramters; for example, the merge_adjacent_files() function on the DuckDB page has no mention of dry_run or others.

Some functions also require passing the catalog as an argument, others have the ducklake name as a prefix. Maybe this is obvious for some, but I would appreciate a more explicit description of the syntax.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions