Sqlserver给表名和列名添加注释

最新推荐文章于 2025-11-02 16:57:25 发布

原创最新推荐文章于 2025-11-02 16:57:25 发布 · 4.1k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#sqlserver #注释

本文详细介绍了如何在SQL Server中为表和列添加及查看注释，包括使用sys.sp_addextendedproperty存储过程进行注释添加的具体步骤，以及通过SQL查询获取表和列注释的方法。

一、表注释

1、添加

--固定写法
EXEC sys.sp_addextendedproperty 
@name=N'MS_Description',@level1type=N'TABLE',
@level0type=N'SCHEMA',@level0name=N'dbo', 
--自定义
@value=N'注释内容' , @level1name=N'表名'

--例
EXEC sys.sp_addextendedproperty 
@name=N'MS_Description',@level1type=N'TABLE',
@level0type=N'SCHEMA',@level0name=N'dbo', 
@value=N'用户表' , @level1name=N'sys_user'

2、查看

SELECT st.name tablename, sep.value tabledesc
FROM sys.tables st
JOIN sys.extended_properties sep
ON sep.major_id = st.object_id
AND minor_id = 0

二、列名注释

1、添加

--固定写法
EXEC sys.sp_addextendedproperty 
@name=N'MS_Description',  
@level0type=N'SCHEMA',@level0name=N'dbo', 
@level1type=N'TABLE',@level2type=N'COLUMN',
--自定义
@level1name=N'表名', @level2name=N'列名',@value=N'注释内容'

--例
EXEC sys.sp_addextendedproperty 
@name=N'MS_Description',  
@level0type=N'SCHEMA',@level0name=N'dbo', 
@level1type=N'TABLE',@level2type=N'COLUMN',
@level1name=N'sys_user', @level2name=N'username',@value=N'用户名称'

2、查看

SELECT sc.name colname, sep.value coldesc
FROM sys.tables st
JOIN sys.columns sc ON sc.object_id = st.object_id
LEFT JOIN sys.extended_properties sep
ON sep.major_id = sc.object_id
AND sep.minor_id = sc.column_id
WHERE st.name = N'sys_user'