SQL Server如何实现编写表与字段注释_Navicat兼容操作步骤-navicat-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 根本读不到那条记录。