SQL中如何为视图添加注释方便运维管理

浅瑶酱_8665

浅瑶酱_8665

2026-07-28

928人浏览

原创

sql server 必须用 sp_addextendedproperty 添加视图注释,不支持 comment on view;需固定前三个参数为 'ms_description'、描述文本、'schema',并显式指定 @level0name(如 'dbo'),否则注释挂错层级。

sql中如何为视图添加注释方便运维管理

SQL Server 必须用 sp_addextendedproperty,别试 COMMENT ON VIEW

SQL Server 根本不支持 COMMENT ON VIEW 这种语法,一执行就报 Incorrect syntax near 'COMMENT'。唯一被 SSMS 识别、被系统表持久化、且官方文档明确支持的方式,只有 sp_addextendedproperty。

关键点有三个:

  • 前三个参数固定为 'MS_Description'、描述文本、'SCHEMA';后两个必须是 'VIEW' 和视图名
  • @level0name 不能省——哪怕视图在 dbo 下,也得显式传 'dbo',否则注释会挂到数据库级,而不是视图上
  • 执行前建议先查是否存在:SELECT * FROM fn_listextendedproperty(NULL, 'SCHEMA', 'dbo', 'VIEW', 'my_view', NULL, NULL),避免重复添加

PostgreSQL 直接用 COMMENT ON VIEW,但 schema 名不能漏

PostgreSQL 支持标准 SQL 的 COMMENT 语法,干净直接。但常见错误是:视图不在 public schema 却没写全路径,结果注释“成功”却查不到。

典型现象是执行完 COMMENT ON VIEW my_view IS 'xxx';,再跑 \d+ my_view 看不到描述——因为系统默认去找 public.my_view,而你的视图实际在 analytics 下。

正确写法必须带 schema:

飞象老师
飞象老师

一款AI办公效率工具,主要用于猿辅导推出的AI教学辅助工具,适合需要提升相关任务效率的用户。

下载
  • COMMENT ON VIEW sales.summary_report IS '按月汇总销售额与退货率';
  • COMMENT ON VIEW analytics.active_users IS '最近30天登录用户去重计数';
  • 删注释用 COMMENT ON VIEW xxx IS NULL;,没有 DROP COMMENT 这种语法

MySQL 只能在 CREATE VIEW 时加 COMMENT,ALTER 不生效

MySQL 8.0+ 允许在 CREATE VIEW 语句末尾加 COMMENT 属性,但仅限建表时指定,ALTER VIEW 不接受 COMMENT 子句——任何试图运行 ALTER VIEW v1 COMMENT 'xxx' 的操作都会报错或被忽略。

这意味着:

  • 上线后发现描述写错?没法热修复,只能 DROP + CREATE 重建视图
  • 重建会重置权限、可能中断依赖它的存储过程或应用查询,线上环境务必评估影响
  • SHOW CREATE VIEW v1 能看到注释,但 INFORMATION_SCHEMA.VIEWS 表里没有独立字段存它,得从 VIEW_DEFINITION 字段里自己解析字符串

字段级注释各数据库差异极大,别混用

视图整体注释只是起点,字段级说明更难统一。SQL Server 用 sp_addextendedproperty 配 @level1type = 'COLUMN';PostgreSQL 对字段用 COMMENT ON COLUMN schema.view.col IS 'xxx';MySQL 则只允许在 SELECT 子句里给字段加 COMMENT(如 id COMMENT '主键'),且仅在 CREATE VIEW 时生效。

最容易踩的坑是:把 PostgreSQL 的字段注释写法复制到 SQL Server,或者以为 MySQL 的 ALTER VIEW 能更新字段注释——这些操作要么报错,要么静默失败,最后谁也看不到你写的说明。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

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

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

2023.10.12

3763

8

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.27

811

4

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

2024.02.23

969

5

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

5561

10

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

2543

4

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

2024.04.07

5540

11

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

2024.04.29

7241

6

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

990

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

872

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习