COMMENT ON
COMMENT ON语句将注释和数据库、表或列关联起来。要想执行COMMENT ON语句,用户需要具有操作对象的CREATE类型权限。
语法格式
COMMENT ON的语法格式如下:
COMMENT ON语句的作用对象只能是数据库、表或者列。
参数说明
- database_name
数据库名称。
- table_name
表名称。
- column_name
表中列的名称。
- table_index_name
表上索引的名称。
- comment_text
注释文本内容(STRING类型)。
语法示例
下面给出示例,分别给数据库、表、表的列、表的索引添加注释。
示例1:给数据库添加注释。
COMMENT ON DATABASE jdb IS ‘manual reference demo database.’;
COMMENT ON DATABASE
注:暂时没有查看数据注释信息的命令。
示例2:给表添加注释。
COMMENT ON TABLE t1 IS ‘manual reference demo table.’;
COMMENT ON TABLE
--查看表上的注释信息
SHOW TABLES FROM jdb WITH COMMENT;
table_name | comment
+——————+———————————————+
t1 | manual reference demo table.
tb1 |
t2 |
(3 rows)