如何查看字段注释_mysql表注释查询

MySQL查看字段注释有五种常用方法:1. SHOW FULL COLUMNS查看整表字段注释;2. 查询INFORMATION_SCHEMA.COLUMNS精准定位单字段注释;3. SHOW CREATE TABLE查看完整建表语句及注释;4. 联查TABLES与COLUMNS批量导出库级字段说明;5. 各方法适用场景明确,覆盖开发、运维与文档需求。

如何查看字段注释_mysql表注释查询

MySQL 中查看字段注释有多种直接有效的方式,关键看你是想查单个字段、整张表的所有字段,还是批量导出用于文档或审计。下面按使用频率和实用性整理出最常用的几种方法。

用 SHOW FULL COLUMNS 快速查整张表字段注释

这是开发时最顺手的方法,一条命令返回所有字段名、类型、是否为空、键信息,以及 Comment 列就是字段注释:

SHOW FULL COLUMNS FROM student;

注意:必须加 FULL,否则 SHOW COLUMNS 不显示注释;结果中 Comment 字段为空表示该字段没写注释。

查指定字段的注释(精准定位)

当你只关心某个字段,比如 user_name 的说明,用 INFORMATION_SCHEMA.COLUMNS 查最准:

SELECT COLUMN_COMMENT FROM INFORMATION_SCHEMA.COLUMNS
  WHERE TABLE_SCHEMA = ‘mydb’
    AND TABLE_NAME = ‘t_user’
    AND COLUMN_NAME = ‘user_name’;

这条语句可嵌入脚本或程序中动态调用,适合自动化场景。

降迹灵AI

降迹灵AI

用户口碑TOP级的降AIGC率、降重平台

下载

用 SHOW CREATE TABLE 看完整建表语句(含所有注释)

它把表结构、字段定义、索引、引擎、字符集和全部注释都原样输出,适合人工核对或备份参考:

SHOW CREATE TABLE t_order;

返回结果里会看到类似这样的片段:

`order_no` varchar(32) COMMENT '订单编号,全局唯一',
...
) ENGINE=InnoDB COMMENT='订单主表';

批量查多个表的所有字段注释(适合运维/文档生成)

如果要导出整个库的字段说明,推荐联查 TABLESCOLUMNS

SELECT
  a.TABLE_NAME AS ‘表名’,
  a.TABLE_COMMENT AS ‘表注释’,
  b.COLUMN_NAME AS ‘字段名’,
  b.COLUMN_COMMENT AS ‘字段注释’,
  b.COLUMN_TYPE AS ‘字段类型’
FROM INFORMATION_SCHEMA.TABLES a
JOIN INFORMATION_SCHEMA.COLUMNS b
  ON a.TABLE_NAME = b.TABLE_NAME
WHERE a.TABLE_SCHEMA = ‘mydb’
  AND a.TABLE_TYPE = ‘BASE TABLE’
ORDER BY a.TABLE_NAME, b.ORDINAL_POSITION;

结果清晰分层,可直接复制进 Excel 或 Markdown 表格生成接口文档。

https://www.php.cn/faq/1963751.html

发表回复

Your email address will not be published. Required fields are marked *