使用 COMMENT 语句对表、视图或列添加注释。
语法
该语句的语法格式如下所示:
COMMENT ON
{ TABLE [ dbname:]{ table }
| COLUMN [ dbname:]
{ table. } column
}
IS 'text' ;
语法图为:
用法
要向表、视图或列添加注释,您必须具有 COMMENT ANY TABLE 权限,或有对
该数据库的 DBA 权限。
您可以通过查询视图 SYSCOMMENTS、SYSCOLCOMMENTS 来查看特定表、
视图或列上的注释。
要从数据库中删除注释,请将其设置为空字符串‘’。
TABLE 子句
指定要添加注释的表或视图的模式和名称,包括所有用户表,不包括系统表。若
连接时指定数据库名,则数据库名可省略。
GBase 8s SQL 指南:语法
南大通用数据技术股份有限公司 194
重要:当您想要向视图添加注释时,也请使用关键字 TABLE ,后跟视图名称,
即可向此视图添加注释。
例如,以下示例向视图 View1 添加注释 ’视图 1’:
COMMENT ON TABLE View1 IS '视图1';
COLUMN 子句
指定要注释的表或视图的列的名称。若连接时指定数据库名,则数据库名可省
略。
IS 'text'
指定注释的文本。
COMMENT ON 的示例
以下示例给 EMPLOYEE 表添加注释:
COMMENT ON TABLE employee IS '员工表';
要查看此表的注释,请执行以下语句:
select * from syscomments where TABNAME='EMPLOYEE';
查询结果为:
TANAME COMMENTS
------------------------------ -------------
EMPLOYEE 员工表
以下示例给 employee 表的 salary 列添加注释:
COMMENT ON COLUMN employees.salary IS '薪水';
要查看此表的列的注释,请执行以下语句:
select * from syscolcomments where TABNAME='EMPLOYEE';
查询结果为:
TABNAME COLNAME COMMENTS
--------------- --------------- -------------
EMPLOYEE EMP_ID
EMPLOYEE NAME
EMPLOYEE ADDRESS
GBase 8s SQL 指南:语法
南大通用数据技术股份有限公司 195
EMPLOYEE SALARY 薪水
要从数据库删除此列的注释,请执行以下语句:
COMMENT ON COLUMN employee.salary IS ' ';
以下示例授予用户注释权限:
GRANT COMMENT ANY TABLE TO user_name;