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

如何给字段添加注释说明_Comments属性配置指南

陌墨酱_4044

陌墨酱_4044

发布时间:2026-04-25 08:54:17

|

1035人浏览过

|

来源于php中文网

原创

SQL Server需用sp_addextendedproperty配合sys.extended_properties添加字段注释,PostgreSQL支持COMMENT ON COLUMN,MySQL 8.0+仅能在ALTER TABLE MODIFY COLUMN时补注释,ORM注释落地依赖方言实现与权限。

SQL Server 里怎么给字段加注释(sys.extended_properties)

sql server 不支持 comment on column 这种标准语法,得靠系统视图 sys.extended_properties 手动加。直接用 sp_addextendedproperty 最稳,但必须指定对象层级(表、列)、schema 名,漏一个就查不到。

  • 先确认目标字段存在:SELECT * FROM sys.columns WHERE name = 'status' AND object_id = OBJECT_ID('dbo.orders')
  • 执行添加(注意引号嵌套和 schema):
    EXEC sp_addextendedproperty 
      @name = N'MS_Description', 
      @value = N'订单当前状态:0-待支付,1-已发货,2-已完成', 
      @level0type = N'SCHEMA', @level0name = N'dbo',
      @level1type = N'TABLE',  @level1name = N'orders',
      @level2type = N'COLUMN', @level2name = N'status';
  • 重复执行会报错 The property cannot be added because it already exists,改用 sp_updateextendedproperty 覆盖,或先删后加

PostgreSQL 怎么用 COMMENT ON COLUMN 加字段说明

PostgreSQL 原生支持,语法简洁,但要注意单引号转义和权限问题——执行用户必须是表 owner 或有 ALTER 权限。

  • 基本写法:COMMENT ON COLUMN public.users.email IS '用户注册邮箱,唯一且非空';
  • 中文注释没问题,但若 SQL 客户端编码不对(比如 pgAdmin 用 GBK 连 UTF8 数据库),可能存成乱码,统一用 UTF8 连接
  • 注释内容不能含未转义的单引号,否则报错 syntax error at or near "s";写成 IS '用户''的手机号'(两个单引号)
  • 注释不参与查询优化,也不影响索引,纯属元数据,导出结构时默认不带,需加 --inserts 或 --clean 参数才保留

MySQL 8.0+ 字段注释只能靠 COMMENT 子句,建表后没法单独加

MySQL 的字段注释只能在 CREATE TABLE 或 ALTER TABLE ... MODIFY COLUMN 时声明,没有独立的 COMMENT ON 语句。想补加?只能改字段定义,哪怕只是重申类型。

  • 新建表时写法:score TINYINT COMMENT '0-100 分制,-1 表示缺考'
  • 已有表补注释:ALTER TABLE exam_results MODIFY COLUMN score TINYINT COMMENT '0-100 分制,-1 表示缺考';
  • 如果只改注释、不改类型,仍要重复写一遍原类型,否则会隐式变成 DEFAULT NULL,导致非空约束丢失
  • SHOW CREATE TABLE 能看到注释,但 INFORMATION_SCHEMA.COLUMNS 里字段是 COLUMN_COMMENT,别拼错

ORM 框架里写注释容易被忽略的兼容点

很多 ORM(如 Django、SQLAlchemy)支持字段级 comment 参数,但生成 DDL 时是否真落地,取决于方言实现和版本。不是写了就一定进数据库。

  • Django 4.2+ 的 models.CharField(comment='...') 只对 PostgreSQL / MySQL 8.0+ 生效,SQL Server 需额外配 db_comment 并启用 django-mssql 扩展
  • SQLAlchemy 的 Column(..., comment='...') 在 create_all() 时才写入,但 Alembic 迁移默认不包含注释变更,得手动加 op.alter_column(..., comment='...')
  • 所有框架生成的注释都绕不开底层 SQL 权限限制——如果应用账号没 ALTER 或 EXECUTE 权,注释就静默失败,日志里可能只有一行 warning

字段注释这事,看着是加个字符串,实际卡点全在权限、方言差异和执行时机上。最常出问题的是:以为 ORM 写了就进了库,结果查 pg_description 或 sys.extended_properties 发现空着;或者 MySQL 改注释时忘了重写字段类型,把 NOT NULL 给弄丢了。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

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

火山引擎

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

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

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

相关专题

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

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

3069

2023.06.20

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

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

2288

2023.07.25

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

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

1220

2023.08.02

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

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

1158

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,随机排序。

1336

2023.09.05

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

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

2118

2023.09.20

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

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

3360

2023.09.20

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

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

15155

2023.09.22

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

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