MSSQL 欄位說明擴充屬性完整操作指南：新增、查詢、刪除

核心系統預存程序

• sp_addextendedproperty：新增/修改說明
• sp_dropextendedproperty：刪除說明
• sp_updateextendedproperty：更新說明（同新增）

新增欄位說明

EXEC sp_addextendedproperty
    @name = N'MS_Description',
    @value = N'這裡填寫欄位說明文字',
    @level0type = N'SCHEMA', @level0name = N'dbo',
    @level1type = N'TABLE',  @level1name = N'TableName',
    @level2type = N'COLUMN', @level2name = N'ColumnName';

刪除欄位說明

EXEC sp_dropextendedproperty
    @name = N'MS_Description',
    @level0type = N'SCHEMA', @level0name = N'dbo',
    @level1type = N'TABLE',  @level1name = N'TableName',
    @level2type = N'COLUMN', @level2name = N'ColumnName';

查詢所有表欄位說明

SELECT
    TABLE_NAME AS [Table Name],
    COLUMN_NAME AS [Column Name],
    value AS [Description]
FROM INFORMATION_SCHEMA.COLUMNS c
LEFT JOIN sys.extended_properties ep
    ON ep.major_id = OBJECT_ID(c.TABLE_SCHEMA + '.' + c.TABLE_NAME)
   AND ep.minor_id = c.ORDINAL_POSITION
   AND ep.name = 'MS_Description'
   AND ep.class = 1
WHERE OBJECTPROPERTY(OBJECT_ID(c.TABLE_SCHEMA + '.' + c.TABLE_NAME), 'IsMsShipped') = 0
ORDER BY TABLE_NAME, ORDINAL_POSITION;

查詢單一表說明

SELECT
    COLUMN_NAME AS [Column Name],
    value AS [Description]
FROM INFORMATION_SCHEMA.COLUMNS c
LEFT JOIN sys.extended_properties ep
    ON ep.major_id = OBJECT_ID('dbo.TableName')
   AND ep.minor_id = c.ORDINAL_POSITION
   AND ep.name = 'MS_Description'
   AND ep.class = 1
WHERE TABLE_NAME = 'TableName'
ORDER BY ORDINAL_POSITION;

參數對照表

擴充：表級、索引級說明

-- 表說明
EXEC sp_addextendedproperty 'MS_Description', '表用途說明', 'SCHEMA', 'dbo', 'TABLE', 'TableName';

-- 索引說明
EXEC sp_addextendedproperty 'MS_Description', '索引用途', 'SCHEMA', 'dbo', 'TABLE', 'TableName', 'INDEX', 'IndexName';

管理工具支援

• SSMS 物件總管 → 右鍵欄位 → 屬性 → 擴充屬性 → 編輯。
• 第三方工具（ApexSQL Doc、Redgate SQL Doc）可自動產出含說明的資料字典文件。

最佳實踐

1. 建表腳本同步包含 sp_addextendedproperty，納入版控。
2. 命名規範：MS_Description 為標準，避免自訂名稱導致工具無法識別。
3. 定期匯出資料字典供業務/測試/新人參考。

善用擴充屬性，讓資料庫自我文檔化，降低溝通成本與維護風險。