COMMENT ON Statement

Search Shortcut cmd + k | ctrl + k

Documentation / SQL / Statements

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

Examples

在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 语句目前有以下限制：