当前位置: 首页 > 数据应用 > SqlServer

SQL Server中如何为表和列添加注释

时间:2023-06-28 14:35:14 SqlServer

SQL Server中的表和列可以添加注释,也就是说明信息,来描述它们的含义、用途、来源等。这样可以方便开发者和维护者了解数据库的结构和设计,也可以提高数据库的可读性和可维护性。

为了给表和列添加注释,我们需要使用SQL语句中的sp_addextendedproperty存储过程。这个存储过程可以为数据库对象添加扩展属性,其中包括注释信息。它的语法如下:

@name = N'MS_Description', -- 扩展属性的名称,固定为MS_Description

@value = N'注释内容', -- 扩展属性的值,即注释内容

@level0type = N'Schema', -- 第一级对象的类型,固定为Schema

@level0name = N'dbo', -- 第一级对象的名称,一般为dbo

@level1type = N'表或视图', -- 第二级对象的类型,可以是Table或View

@level1name = N'表或视图名称', -- 第二级对象的名称,即表或视图名称

@level2type = N'Column', -- 第三级对象的类型,可以是Column或Index

@level2name = N'列名称' -- 第三级对象的名称,即列名称

例如,如果我们想给student表中的name列添加一个注释“学生姓名”,我们可以使用以下语句:

@value = N'学生姓名',

如果我们想给student表本身添加一个注释“学生信息表”,我们可以省略第三级对象的类型和名称,使用以下语句:

@value = N'学生信息表',

同理,我们也可以给视图和索引添加注释,只需要修改第二级和第三级对象的类型和名称即可。

添加了注释后,我们可以通过查询系统视图sys.extended_properties来查看扩展属性。