像代码一样,可以为表以及表中的列添加注释,方便其他人知晓其功能。对于一些字段,在经过一定时间后,创建者未必也能想起其具体的含意,所以注释显得尤为重要。
注释的添加
注释的添加是通过在定义表或列的时候在末尾加上 COMMENT 关键字来实现的,最长支持 1024 个字符。
可以在创建表的时候为表和列添加相应的注释。
CREATE TABLE test_comment
(
id SERIAL PRIMARY KEY,
col1 INT comment '列的注释'
)
comment '表的注释';
执行上面的语句后创建了一个名为 test_comment 的表,并且为表和其中的 col1 列指定了相应的注释。
然后可通过 SHOW CREATE TABLE 来查看。
MySQL> SHOW CREATE TABLE test_comment\G
*************************** 1. row ***************************
Table: test_comment
Create Table: CREATE TABLE `test_comment` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`col1` int(11) DEFAULT NULL COMMENT '列的注释',
PRIMARY KEY (`id`),
UNIQUE KEY `id` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci COMMENT='表的注释'
1 row in set (0.00 sec)
注释的查看
除了 SHOW CREATE TABLE 语法,还有其他一些查看注释的方式。
SHOW TABLE STATUS 能够查看表的注释,其语法为:
SHOW TABLE STATUS WHERE name='table_name';
以下是通过 SHOW TABLE STATUS 查看的结果:
mysql> SHOW TABLE STATUS WHERE name=