COMMENT ON 语句 – DuckDB 数据库

搜索快捷键 cmd + k | ctrl + k

文档 / SQL / 语句

COMMENT ON 语句

COMMENT ON 语句允许向目录条目（表、列等）添加元数据。它遵循 PostgreSQL 语法。

示例

创建关于 TABLE 的注释

COMMENT ON TABLE test_table IS 'very nice table';

创建关于 COLUMN 的注释

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

创建关于 VIEW 的注释

COMMENT ON VIEW test_view IS 'very nice view';

创建关于 INDEX 的注释

COMMENT ON INDEX test_index IS 'very nice index';

创建关于 SEQUENCE 的注释

COMMENT ON SEQUENCE test_sequence IS 'very nice sequence';

创建关于 TYPE 的注释

COMMENT ON TYPE test_type IS 'very nice type';

创建关于 MACRO 的注释

COMMENT ON MACRO test_macro IS 'very nice macro';

创建关于 MACRO TABLE 的注释

COMMENT ON MACRO TABLE test_table_macro IS 'very nice table macro';

要取消注释，请将其设置为 NULL，例如：

COMMENT ON TABLE test_table IS NULL;

可以通过查询相应的元数据函数的 comment 列来读取注释

列出 TABLE 的注释

SELECT comment FROM duckdb_tables();

列出 COLUMN 的注释

SELECT comment FROM duckdb_columns();

列出 VIEW 的注释

SELECT comment FROM duckdb_views();

列出 INDEX 的注释

SELECT comment FROM duckdb_indexes();

列出 SEQUENCE 的注释

SELECT comment FROM duckdb_sequences();

列出 TYPE 的注释

SELECT comment FROM duckdb_types();

列出 MACRO 的注释

SELECT comment FROM duckdb_functions();

列出 MACRO TABLE 的注释

SELECT comment FROM duckdb_functions();

COMMENT ON 语句目前有以下限制