COMMENT ON 语句
COMMENT ON 语句允许为 catalog 对象(表、列等)添加元数据注释。
其语法遵循 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 goose_tables();
查看 COLUMN 注释:
SELECT comment FROM goose_columns();
查看 VIEW 注释:
SELECT comment FROM goose_views();
查看 INDEX 注释:
SELECT comment FROM goose_indexes();
查看 SEQUENCE 注释:
SELECT comment FROM goose_sequences();
查看 TYPE 注释:
SELECT comment FROM goose_types();
查看 MACRO 注释:
SELECT comment FROM goose_functions();
查看 MACRO TABLE 注释:
SELECT comment FROM goose_functions();
限制
COMMENT ON 当前有以下限制:
- 暂不支持为 schema 或 database 添加注释。
- 暂不支持为有依赖关系的对象添加注释(如已有索引的表)。