List the tables and views in a DuckLake catalog — list_ducklake_tables • ducklake

Returns every table and view in the lake as a tidy data frame – the quick answer to "what is in here?".

Usage

list_ducklake_tables(ducklake_name = NULL)

Arguments

ducklake_name: Optional name of the attached DuckLake catalog. If NULL, the current database is used.

Value

A data frame with one row per object: schema_name, table_name, and type ("table" or "view").

See also

get_table_info() for per-table file statistics, get_table_comments() for stored documentation, get_ducklake_table() to read any listed object.

Other table operations: add_data_files(), create_schema(), create_table(), create_view(), drop_schema(), drop_view(), ducklake_exec(), get_ducklake_table(), get_metadata_table(), replace_table(), show_ducklake_query()

Examples

lake_dir <- tempfile("list_lake_")
dir.create(lake_dir)
attach_ducklake("list_lake", lake_path = lake_dir)
create_table(mtcars, "cars")

list_ducklake_tables()
#>   schema_name table_name  type
#> 1        main       cars table

detach_ducklake("list_lake", shutdown = TRUE)
unlink(lake_dir, recursive = TRUE)