⌘+k ctrl+k
1.4 (LTS)
搜索快捷键 cmd + k | ctrl + k
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 语句目前存在以下限制:

  • 无法对模式(schemas)或数据库(databases)进行注释。
  • 无法对具有依赖关系的对象(例如带有索引的表)进行注释。

语法

© 2025 DuckDB 基金会,阿姆斯特丹,荷兰
行为准则 商标使用指南