使用SQL Server添加表注释的简明方法

添加表注释的简明方法

在日常的工作中，为了更好地管理和维护数据库，我们需要为表添加注释，以便让维护人员更快地了解表的用途和结构。本文将介绍如何使用 SQL Server 添加表注释。

1. 使用 SSMS 添加表注释

SQL Server Management Studio（SSMS）是 SQL Server 数据库的官方管理工具。通过使用 SSMS，你可以通过图形界面轻松地添加表注释。接下来我们来看一下如何使用 SSMS 添加表注释。

在 SSMS 中，右键点击要添加注释的表，选择“Properties”。

在弹出的窗口中，选择“Extended Properties”选项卡，然后点击“Add”按钮。

在“Add Extended Property”窗口中，填写“Name”为“MS_Description”（此名称为固定值，无需修改），“Value”为要添加的表注释。

点击“OK”按钮后，表注释就会被成功地添加到该表的扩展属性中。

-- 添加表注释
EXEC sys.sp_addextendedproperty 
@name = N'MS_Description', 
@value = N'这是一张测试表', 
@level0type = N'SCHEMA',
@level0name = dbo, 
@level1type = N'TABLE',
@level1name = test_table; 
GO
-- 获取表注释
SELECT objtype, objname, name, value FROM sys.extended_properties
WHERE objname = 'test_table';
GO
-- 删除表注释
EXEC sys.sp_dropextendedproperty 
@name = N'MS_Description', 
@level0type = N'SCHEMA',
@level0name = dbo, 
@level1type = N'TABLE',
@level1name = test_table; 
GO

2. 使用 T-SQL 添加表注释

虽然 SSMS 可以轻松添加表注释，但如果需要在代码中添加表注释，使用 T-SQL 是更好的选择。T-SQL 是 SQL Server 的内置脚本语言，可以用来创建和修改数据库对象。接下来我们来看一下如何使用 T-SQL 添加表注释。

在 T-SQL 中，使用存储过程 sys.sp_addextendedproperty 可以添加表注释。下面的代码演示了如何使用 T-SQL 添加和删除表注释：

-- 添加表注释
EXEC sys.sp_addextendedproperty 
@name = N'MS_Description', 
@value = N'这是一张测试表', 
@level0type = N'SCHEMA',
@level0name = dbo, 
@level1type = N'TABLE',
@level1name = test_table; 
GO
-- 获取表注释
SELECT objtype, objname, name, value FROM sys.extended_properties
WHERE objname = 'test_table';
GO
-- 删除表注释
EXEC sys.sp_dropextendedproperty 
@name = N'MS_Description', 
@level0type = N'SCHEMA',
@level0name = dbo, 
@level1type = N'TABLE',
@level1name = test_table; 
GO

总结

无论是使用 SSMS 还是 T-SQL，添加表注释都是非常容易的。添加表注释可以帮助维护人员更快地了解表的用途和结构，从而更好地管理和维护数据库。