注释
数据库对象和数据库本身可以包含注释。这是一个方便的记录机制数据库的开发和维护。使用COMMENT ON创建的注释在gbak创建备份和恢复备份时将继续存在。
COMMENT ON
作用:记录元数据
用于: DSQL
语法:
COMMENT ON <object> IS {'sometext' | NULL}
<object> ::=
DATABASE
| <basic-type> objectname
| COLUMN relationname.fieldname
| PARAMETER procname.paramname
<basic-type> ::=
CHARACTER SET |
COLLATION |
DOMAIN |
EXCEPTION |
EXTERNAL FUNCTION |
FILTER |
GENERATOR |
INDEX |
PROCEDURE |
ROLE |
SEQUENCE |
TABLE |
TRIGGER |
VIEW
表 5.46. COMMENT ON 语句参数
参数 | 描述 |
sometext | 注释文本 |
basic-type | 元数据对象类型 |
objectname | 元数据对象名称 |
relationname | 表或视图名称 |
procname | 存储过程名称 |
paramname | 存储过程参数名称 |
COMMENT ON 语句为数据库对象(元数据)增加注释.注释被保存为BLOB类型的文本字段在相应的系统表的 RDB$DESCRIPTION列中,客户端应用程序能够从这些字段中查看注释。
备注
如果增加一个空的注释(''),它将被当作NULL值在数据库中
表或存储过程的所都者和管理员拥有使用COMMENT ON的权限.
使用COMMENT ON的例子:
1. 为当前数据为增加一个注释
COMMENT ON DATABASE IS 'It is a test (''my.fdb'') database';
2.为METALS表增加一个注释
COMMENT ON TABLE METALS IS 'Metal directory';
3. 为在METALS表中的ISALLOY字段增加一个注释
COMMENT ON COLUMN METALS.ISALLOY IS '0 = fine metal, 1 = alloy';
4. 为一个参数增加一个注释
COMMENT ON PARAMETER ADD_EMP_PROJ. EMP_NO IS 'Employee ID';