SQL Server 利用擴展屬性為資料欄位新增說明註釋

前言

良好的資料庫文檔化習慣能大幅降低團隊溝通成本。SQL Server 提供sys.sp_addextendedproperty 系統預存程序，可為資料表欄位新增描述性註釋（Description），這些資訊會保留在系統目錄中，方便後續查閱與工具自動生成文檔。

標準語法範例

EXEC sys.sp_addextendedproperty
    @name = N'MS_Description',
    @value = N'角色Id',        -- 註釋內容
    @level0type = N'SCHEMA',
    @level0name = N'dbo',
    @level1type = N'TABLE',
    @level1name = N'roleMenuInfo',  -- 目標資料表
    @level2type = N'COLUMN',
    @level2name = N'roleId';        -- 目標欄位
GO

參數說明

補充技巧

• 同樣語法可用於資料表、檢視表、預存程序等物件（調整 @level1type、@level2type）
• 查詢現有註釋：SELECT * FROM sys.extended_properties WHERE major_id = OBJECT_ID('dbo.roleMenuInfo') AND minor_id = COLUMNPROPERTY(OBJECT_ID('dbo.roleMenuInfo'), 'roleId', 'ColumnId')
• 更新註釋請使用 sys.sp_updateextendedproperty；刪除用 sys.sp_dropextendedproperty