COMMENT 语句

最近更新时间:2026-05-06 16:28:13

我的收藏
COMMENT 语句用于为数据库、表或列添加、修改或删除描述性注释。这些注释存储在元数据中,方便通过查询工具查看。

语法

-- 为数据库设置或移除注释
COMMENT ON DATABASE db_name IS {'comment_string' | NULL}

-- 为表设置或移除注释
COMMENT ON TABLE [db_name.]table_name IS {'comment_string' | NULL}

-- 为列设置或移除注释
COMMENT ON COLUMN [db_name.]table_name.column_name IS {'comment_string' | NULL}

参数说明

db_name:可选。如果目标数据库不是当前所在的数据库,则必须指定。
NULL:如果指定为 NULL,则会从指定对象中移除已有的注释。
'comment_string':注释内容。字符串必须用单引号包裹。
长度限制:注释最长可达 256 个字符。

操作示例

添加或修改注释

COMMENT ON DATABASE sales_db IS '该库包含所有销售交易数据';
COMMENT ON TABLE sales_db.orders IS '订单主表,按日期分区';
COMMENT ON COLUMN sales_db.orders.order_id IS '订单唯一识别码';

移除已有注释

COMMENT ON COLUMN orders.order_id IS NULL;

其他设置与查看方式

除了 COMMENT ON 语句,您还可以通过以下方式管理注释:
1. 创建对象时添加:在 CREATE TABLE 时使用 COMMENT 关键字。
CREATE TABLE t1 (id INT COMMENT '用户ID') COMMENT '用户信息表';
2. 修改表属性时添加:使用 ALTER TABLE 修改属性。
ALTER TABLE t1 SET TBLPROPERTIES('comment' = '新的表描述');
3. 查看注释:使用 DESCRIBE 命令查看列注释,或使用 SHOW CREATE TABLE 查看表注释。
DESCRIBE table_name; -- 查看列的 Comment 字段
DESCRIBE FORMATTED table_name; -- 查看表的详细元数据和注释
SHOW CREATE TABLE table_name; -- 查看完整的建表 SQL 及注释