Comments

Search Shortcut cmd + k | ctrl + k

Documentation / DuckDB Extension / Advanced Features

Comments

Comments can be added to tables, views and columns using the COMMENT ON syntax. The comments are stored in the metadata, and can be modified in a transactional manner:

For tables and views, comments are in the ducklake_tag table.
For table columns, comments are in the ducklake_column_tag table.
For view columns, comments are in the ducklake_view_column_tag table.

Examples

Create a comment on a TABLE:

COMMENT ON TABLE test_table IS 'very nice table';

Create a comment on a COLUMN:

COMMENT ON COLUMN test_table.test_table_column IS 'very nice column';

Create a comment on a view column:

CREATE VIEW test_view (view_column) AS
    SELECT test_table_column FROM test_table;
COMMENT ON COLUMN test_view.view_column IS 'very nice view column';

View column comments use the view's output column names and require DuckLake format version 1.1.

DuckLake Home Manifesto Blog