DuckLake functions

DuckLake functions provide table-valued functions for reading DuckLake tables. DuckLake keeps table metadata in a SQL catalog database (PostgreSQL) and stores the underlying data as Parquet files in object storage or on a local filesystem.

DuckLake support is experimental and may change. Only DuckLake catalogs hosted on PostgreSQL are supported.

Reading DuckLake data

Use the READ_DUCKLAKE table-valued function to query a DuckLake table. Firebolt recommends storing the catalog connection string and storage credentials in a location object:

CREATE LOCATION my_ducklake_loc WITH
  SOURCE = DUCKLAKE
  CATALOG = 'postgresql://dl_user:dl_pw@127.0.0.1:5432/dl_db';

SELECT *
FROM READ_DUCKLAKE(
  LOCATION => 'my_ducklake_loc',
  TABLE => 'my_first_ducklake_table'
)
LIMIT 5;

Inspecting DuckLake data files

Use the LIST_DUCKLAKE_FILES table-valued function to list the Parquet data files behind a table, with per-file metadata and per-column statistics:

SELECT file_name, record_count, file_size
FROM LIST_DUCKLAKE_FILES(
  LOCATION => 'my_ducklake_loc',
  TABLE => 'my_first_ducklake_table'
);

Available functions

Table-valued functions:

READ_DUCKLAKE — Read data from a DuckLake table.
LIST_DUCKLAKE_FILES — List the data files that make up a DuckLake table.

CREATE LOCATION (DuckLake) — Store catalog connection details and credentials in a reusable location object.
Query DuckLake tables with Firebolt Core — A step-by-step guide to setting up a DuckLake catalog and reading it from Firebolt.

ICEBERG_TRUNCATE

READ_DUCKLAKE

⌘I

Overview

Performance and Observability

Security

Self-Managed

Managed service

Guides

SQL reference

Release notes

API reference

Legal

Reading DuckLake data

Inspecting DuckLake data files

Available functions

​Reading DuckLake data

​Inspecting DuckLake data files

​Available functions

​Related

Reading DuckLake data

Inspecting DuckLake data files

Available functions

Related