很多場(chǎng)景下，我們需要查看 MySQL 中表注釋，或者是某張表下所有字段的注釋，所以本文就來(lái)盤(pán)點(diǎn)和對(duì)比一下查詢注釋的幾種方式。
創(chuàng)建測(cè)試數(shù)據(jù)庫(kù)
開(kāi)始之前咱們先創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)，以備下面演示使用。
- -- 如果存在就先刪除數(shù)據(jù)庫(kù)
- drop database if exists test2022;
- -- 創(chuàng)建數(shù)據(jù)庫(kù)
- create database test2022;
- -- 切換數(shù)據(jù)庫(kù)
- use test2022;
- -- 創(chuàng)建表和字段（以及相應(yīng)的注釋）
- CREATE TABLE `student` (
- `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '學(xué)生編號(hào)',
- `sn` varchar(50) DEFAULT NULL COMMENT '學(xué)號(hào)',
- `username` varchar(250) NOT NULL COMMENT '學(xué)生名稱',
- `mail` varchar(250) DEFAULT NULL COMMENT '郵箱',
- `class_id` int(11) DEFAULT NULL,
- PRIMARY KEY (`id`)
- ) comment='學(xué)生表' ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4
查詢所有表注釋
使用以下 SQL 可以查詢某個(gè)數(shù)據(jù)庫(kù)下所有表的注釋：
- SELECT table_name 表名, table_comment 表說(shuō)明
- FROM information_schema.TABLES
- WHERE table_schema='數(shù)據(jù)庫(kù)名'
- ORDER BY table_name
案例：查詢 test2022 數(shù)據(jù)庫(kù)中的所有表注解：
- SELECT table_name 表名, table_comment 表說(shuō)明
- FROM information_schema.TABLES
- WHERE table_schema='test2022'
- ORDER BY table_name
執(zhí)行結(jié)果如下圖所示：
查詢所有字段注釋
字段注釋查詢方式1
查詢語(yǔ)法如下：
- show full columns from 表名;
案例：查詢 student 表中所有字段的注釋信息：
- show full columns from student;
執(zhí)行結(jié)果如下圖所示：
字段注釋查詢方式2
查詢語(yǔ)法如下：
- select COLUMN_NAME 字段名,column_comment 字段說(shuō)明,column_type 字段類型,
- column_key 約束 from information_schema.columns
- where table_schema='數(shù)據(jù)庫(kù)名' and table_name='表名';
案例：查詢 student 表中所有字段的注釋信息：
- select COLUMN_NAME 字段名,column_comment 字段說(shuō)明,column_type 字段類型,
- column_key 約束 from information_schema.columns
- where table_schema='test2022' and table_name='student';
執(zhí)行結(jié)果如下圖所示：
字段注釋查詢方式3
查詢表的 DDL(數(shù)據(jù)定義語(yǔ)言)也可以看到字段的注釋內(nèi)容，執(zhí)行的 SQL 語(yǔ)法如下：
- show create table 表名;
案例：查詢 student 表中所有字段的注釋信息：
- show create table student;
執(zhí)行結(jié)果如下圖所示：
字段注釋查詢方式4
如果使用的是 Navicat 工具，可以在表上右鍵、再點(diǎn)設(shè)計(jì)，到設(shè)計(jì)頁(yè)面就可以查看字段注釋了，如下圖所示：
但這種操作有點(diǎn)危險(xiǎn)，小心手抖把表結(jié)構(gòu)改錯(cuò)了。
字段注釋查詢方式5
在 Navicat 中查看表的 DDL 語(yǔ)句也可以看到字段注釋，選中表再點(diǎn)擊右下腳“顯示右邊窗口”選項(xiàng)，然后再點(diǎn)擊 DDL 就可以顯示了，具體操作步驟如下圖所示：圖片
修改表注釋和字段注釋
修改表注釋
修改表注釋的語(yǔ)法：
- alter table 表名 comment ='修改后的表注釋';
案例：修改 student 的表注釋：
- alter table student comment ='學(xué)生表 V2';
執(zhí)行結(jié)果如下圖所示：
修改字段注釋
修改表注釋的語(yǔ)法：
- alter table 表名 modify column 字段名 int comment '注釋信息';
案例：修改 student 表中 name 的注釋：
- alter table student modify column username int comment '學(xué)生姓名 V2';
執(zhí)行結(jié)果如下圖所示：
總結(jié)
本文介紹了查看表注釋的 SQL，以及修改表和字段注釋的 SQL，同時(shí)還介紹了查看字段注釋的 5 種方法：3 種命令行操作方式查看，兩種基于 Navicat 的操作方式查看，其中推薦使用 SQL：“show full columns from 表名”查看字段注釋，這種查詢 SQL 簡(jiǎn)單且也不用擔(dān)心會(huì)誤改表結(jié)構(gòu)。
原文鏈接：https://mp.weixin.qq.com/s/Q0stgvM8MIlXIYHzQbyokA
