SQL Server——建表时为字段添加注释

在 MySQL 中，新建数据库表为字段添加注释可以使用 comment 属性来实现。SQL Server 没有 comment 属性，但是可以通过执行 sys.sp_addextendedproperty 这个存储过程添加扩展属性来实现相同的功能。

这个存储过程的参数定义如下：

exec sys.sp_addextendedproperty
    @name, @value,
    @level0type, @level0name,
    @level1type, @level1name,
    @level2type, @level2name
go

固定的参数如下：

exec sys.sp_addextendedproperty
    'MS_Description', @value,
    'SCHEMA', @level0name,
    'TABLE', @level1name,
    'COLUMN', @level2name
go

• @value：要备注的内容。
• @level0name：建表时指定的架构名。如果没有指定架构，填：dbo。
• @level1name：表名。
• @level2name：列名。

示例：

create table student
(
    id   bigint       not null primary key,
    name nvarchar(255),
)

exec sp_addextendedproperty 
	'MS_Description', N'名称', 
	'SCHEMA', 'dbo', 
	'TABLE', 'student', 
	'COLUMN', 'name'
go

select *
from student

DataGrip 显示效果为：