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

SQL Server如何实现编写表与字段注释_Navicat兼容操作步骤

夏杰同学_7985

夏杰同学_7985

发布时间:2026-03-26 10:20:32

|

1022人浏览过

|

来源于php中文网

原创

SQL Server添加表/字段注释必须用sp_addextendedproperty,指定完整三级层级(SCHEMA/TABLE/COLUMN)及架构名如'dbo',Navicat依赖sys.extended_properties读取,需确保权限与路径精准匹配。

SQL Server 添加表注释:用 sp_addextendedproperty 而不是 COMMENT ON

sql server 没有标准 sql 的 comment on table 语法,navicat 界面里点“添加备注”背后实际调用的是系统存储过程 sp_addextendedproperty。直接写 comment on 会报错:incorrect syntax near 'comment'。

实操建议:

  • 必须指定 @level0type = N'SCHEMA' 和 @level1type = N'TABLE',否则注释可能挂到数据库或用户上,Navicat 刷新后看不到
  • 注释值(@value)最大支持 7500 字符,但 Navicat 只显示前几百字符,长文本慎用
  • 如果表在 dbo 架构下,@level0name 必须写 N'dbo',不能省略或写成空字符串
  • 示例:
    EXEC sys.sp_addextendedproperty 
      @name = N'MS_Description', 
      @value = N'用户主表,含注册时间与状态字段', 
      @level0type = N'SCHEMA', @level0name = N'dbo',
      @level1type = N'TABLE',  @level1name = N'users';

SQL Server 添加字段注释:注意三级对象层级和重复执行风险

字段注释同样靠 sp_addextendedproperty,但要补全 @level2type 和 @level2name。Navicat 修改字段备注时会自动加这层,手写容易漏掉,导致注释出现在表级而非字段级。

常见错误现象:执行完后在 Navicat 表设计页看不到字段备注,但用 SELECT * FROM fn_listextendedproperty 能查到——说明挂错层级了。

实操建议:

  • 字段注释必须带 @level2type = N'COLUMN' 和准确的字段名(@level2name),大小写需与实际列名一致(SQL Server 默认不区分,但 Navicat 读取时可能敏感)
  • 重复执行同一语句不会报错,但会覆盖旧注释;若想安全更新,先用 sp_updateextendedproperty,或加 IF NOT EXISTS 判断
  • 示例:
    EXEC sys.sp_addextendedproperty 
      @name = N'MS_Description', 
      @value = N'手机号,已脱敏存储', 
      @level0type = N'SCHEMA', @level0name = N'dbo',
      @level1type = N'TABLE',  @level1name = N'users',
      @level2type = N'COLUMN', @level2name = N'phone';

Navicat 刷新不到注释?检查 extended property 是否被误删或权限不足

Navicat 读取注释依赖系统视图 sys.extended_properties。如果刷新后空白,大概率不是 Navicat 问题,而是注释没写对位置,或当前登录用户没权限查该视图。

使用场景:DBA 给开发账号只开了 db_datareader,但没显式授权查 sys 视图,Navicat 就拿不到注释。

实操建议:

  • 用以下语句手动验证注释是否存在:
    SELECT objname, value FROM fn_listextendedproperty(N'MS_Description', N'SCHEMA', N'dbo', N'TABLE', N'users', N'COLUMN', DEFAULT);
  • 若返回空,说明注释根本没写进去;若返回值但 Navicat 不显示,检查连接用户是否有 VIEW DEFINITION 权限(尤其在生产库限制严格时)
  • Navicat 15+ 版本默认从 sys.extended_properties 读,旧版本可能缓存严重,尝试关闭再重连

批量加注释脚本:避免硬编码,用查询动态生成 sp_addextendedproperty

给几十张表上百字段补注释时,手写太容易出错。最稳的方式是用系统视图查出目标对象,拼出可执行语句,再人工核对后运行。

性能影响极小,但要注意生成逻辑别把视图、系统表也卷进来。

实操建议:

  • 过滤条件必须包含 o.type = 'U'(用户表),排除视图(V)、系统表(S)等
  • 字段注释语句中,@level1name 和 @level2name 建议用 QUOTENAME() 包裹,防表名/字段名含空格或特殊字符
  • 简单生成模板:
    SELECT 'EXEC sys.sp_addextendedproperty @name = N''MS_Description'', @value = N''' + ISNULL(c.[description], '') + ''', @level0type = N''SCHEMA'', @level0name = N''' + s.name + ''', @level1type = N''TABLE'', @level1name = N''' + t.name + ''', @level2type = N''COLUMN'', @level2name = N''' + c.name + ''';'<br>FROM sys.tables t<br>JOIN sys.schemas s ON t.schema_id = s.schema_id<br>JOIN sys.columns c ON t.object_id = c.object_id<br>LEFT JOIN sys.extended_properties ep ON ep.major_id = c.object_id AND ep.minor_id = c.column_id AND ep.name = 'MS_Description'<br>WHERE t.name IN ('users', 'orders') AND ep.value IS NULL;

Navicat 兼容的关键不在界面操作,而在每条注释是否精准落在 sys.extended_properties 对应的三级路径上。最容易被忽略的是架构名写错、字段名大小写不一致、以及用户权限缺失导致 Navicat 根本读不到那条记录。

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

热门AI工具

更多
WorkBuddy

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

蛙蛙写作

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

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

DeepSeek

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

相关专题

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

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

3529

2023.06.20

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

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

2408

2023.07.25

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

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

1340

2023.08.02

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

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

1298

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

1416

2023.09.05

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

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

2318

2023.09.20

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

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

3800

2023.09.20

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

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

17755

2023.09.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

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