讲师中心 微信公众号
AI工具推荐 视频效率加速

mysql给字段添加注释的SQL写法_Comment属性详解

夏涛大大_3398

夏涛大大_3398

发布时间:2026-04-05 11:02:34

|

758人浏览过

|

来源于php中文网

原创

MySQL 5.7+ 给已有字段补注释需用 MODIFY COLUMN 或 CHANGE COLUMN 配合 COMMENT;单独 ADD COLUMN COMMENT 仅适用于新增字段,查看注释应查 information_schema.COLUMNS 或用 SHOW CREATE TABLE。

mysql给字段添加注释的sql写法_comment属性详解

ALTER TABLE 添加字段注释的正确写法

MySQL 5.7+ 支持直接在 ALTER TABLE 中用 COMMENT 给字段加注释,但必须配合 MODIFY COLUMN 或 CHANGE COLUMN,不能只写 COMMENT —— 单独用 ALTER TABLE ... COMMENT 是给整张表加注释的,不是字段。

常见错误是这么写:ALTER TABLE user ADD COLUMN name VARCHAR(50) COMMENT '用户名' —— 这条本身没错,但如果是想「给已有字段补注释」,就必须重定义字段类型:

  • ALTER TABLE user MODIFY COLUMN name VARCHAR(50) COMMENT '用户名';
  • 或更稳妥的写法(保留原字段名):ALTER TABLE user CHANGE COLUMN name name VARCHAR(50) COMMENT '用户名';

注意:两种方式都会触发表重建(尤其大表要谨慎),MODIFY 要求类型完全一致,CHANGE 允许同时改名和类型,但多一个参数,容易手抖漏写字段名。

查看字段注释的三种可靠方式

字段注释存在 information_schema.COLUMNS 表里,不是所有客户端都默认展示。别依赖 DESCRIBE table_name 或 SHOW COLUMNS —— 它们在某些 MySQL 版本或客户端里会省略 COLUMN_COMMENT 列。

MySQL
MySQL

编写正确的MySQL查询,避免字符集、索引和锁方面的常见陷阱。

下载
  • 查单个字段:SELECT COLUMN_NAME, COLUMN_COMMENT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = 'your_db' AND TABLE_NAME = 'user' AND COLUMN_NAME = 'name';
  • 查整张表所有带注释的字段:SELECT COLUMN_NAME, DATA_TYPE, COLUMN_COMMENT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = 'your_db' AND TABLE_NAME = 'user' AND COLUMN_COMMENT != '';
  • 用 SHOW CREATE TABLE user\G(注意末尾 \G),输出里每个字段定义后紧跟 COMMENT,最直观,但不便于脚本解析。

COMMENT 字符串里的单引号和换行怎么处理

MySQL 的 COMMENT 值本质是字符串字面量,受 SQL 字符串规则约束。如果你写 COMMENT '用户's姓名',会报错 ERROR 1064 (42000) —— 因为单引号没转义。

  • 单引号必须写成两个单引号:COMMENT '用户''s姓名'
  • 换行符可以保留,但需确保客户端/驱动支持(比如 Python 的 mysql-connector 默认允许,但某些老版本 JDBC 需设 allowMultiQueries=true)
  • 最大长度是 1024 字符,超长会被静默截断,不会报错,也查不到警告 —— 所以加完务必用前面说的方法验证是否完整存进去了。

COMMENT 不生效的典型场景

注释不是元数据“强约束”,它只是存储在系统表里的一段文本,很多工具链根本不读它。最容易被忽略的是:

  • ORM 框架(如 Django、SQLAlchemy)默认不读取 COLUMN_COMMENT,生成 model 时注释就丢了;得额外配插件或手动补
  • mysqldump 默认不导出 COMMENT,除非加 --comments 参数
  • MySQL 5.6 及更早版本对 COMMENT 支持不完整,比如 TEXT 类型字段加注释可能失败,升级前先测
  • 字段类型变更时如果没显式带上 COMMENT,原有注释会被清空 —— 例如 MODIFY COLUMN name VARCHAR(100) 不写 COMMENT,原来的注释就没了。

真正要用好 COMMENT,得把它当成文档的一部分来维护,而不是加完就不管。尤其是多人协作时,字段含义变了但注释没同步,比没注释还危险。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3429

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2388

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1320

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1278

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1396

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2278

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3700

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

17255

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL vs MySQL
PostgreSQL vs MySQL

共1课时 | 192人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn