使用 sql 語句創建表時,可以使用系統存儲過程 sp_addextendedproperty 給字段添加描述說明。
sp_addextendedproperty 語法:
1 sp_addextendedproperty 2 [ @name = ] { 'property_name' } 3 [ , [ @value = ] { 'value' } 4 [ , [ @level0type = ] { 'level0_object_type' } 5 , [ @level0name = ] { 'level0_object_name' } 6 [ , [ @level1type = ] { 'level1_object_type' } 7 , [ @level1name = ] { 'level1_object_name' } 8 [ , [ @level2type = ] { 'level2_object_type' } 9 , [ @level2name = ] { 'level2_object_name' } 10 ] 11 ] 12 ] 13 ] 14 [;]
1 execute sys.sp_addextendedproperty 2 @name = N'MS_Description', 3 @value = N'要添加的屬性信息', 4 @level0type = N'Schema', 5 @level0name = N'dbo', 6 @level1type = N'table', 7 @level1name = N'表名', 8 @level2type = N'column', 9 @level2name = N'列名'
參數:
[ @name ] = { 'property_name' }
是要添加的屬性的名稱。 property_name是sysname和不能為 NULL。 名稱還可以包括空格或非字母數字字符串以及二進制值。
[ @value= ] { 'value'}
要與屬性關聯的值。 值是sql_variant,默認值為 NULL。 value 的大小不能超過 7,500 個字節。
[ @level0type=] {level0_object_type}
級別 0 對象的類型。 level0_object_type是varchar (128),默認值為 NULL。
有效輸入包括:ASSEMBLY、CONTRACT、EVENT NOTIFICATION、FILEGROUP、MESSAGE TYPE、PARTITION FUNCTION、PARTITION SCHEME、REMOTE SERVICE BINDING、ROUTE、SCHEMA、SERVICE、USER、TRIGGER、TYPE、PLAN GUIDE 和 NULL。
[ @level0name=] {level0_object_name}
所指定的級別 0 對象類型的名稱。 level0_object_name是sysname默認值為 NULL。
[ @level1type=] {level1_object_type}
級別 1 對象的類型。 level1_object_type是varchar (128),默認值為 NULL。
有效的輸入包括:AGGREGATE、DEFAULT、FUNCTION、LOGICAL FILE NAME、PROCEDURE、QUEUE、RULE、SYNONYM、TABLE、TABLE_TYPE、TYPE、VIEW、XML SCHEMA COLLECTION 和 NULL。
[ @level1name=] {level1_object_name}
所指定的級別 1 對象類型的名稱。 level1_object_name是sysname,默認值為 NULL。
[ @level2type=] {level2_object_type}
級別 2 對象的類型。 level2_object_type是varchar (128),默認值為 NULL。
有效的輸入包括:COLUMN、CONSTRAINT、EVENT NOTIFICATION、INDEX、PARAMETER、TRIGGER 和 NULL。
[ @level2name=] {level2_object_name}
所指定的級別 2 對象類型的名稱。 level2_object_name是sysname,默認值為 NULL。
0(成功)或 1(失敗)
1 create table Department 2 ( 3 D_ID int not null identity(1,1) primary key, 4 D_Name varchar(50) not null unique, 5 D_Url varchar(200) null , 6 D_ImgUrl varchar(200) null, 7 D_ParentID int not null default(0), 8 D_Remark varchar(500) null 9 ) 10 go 11 12 --為表(Department)添加描述信息 13 execute sys.sp_addextendedproperty N'MS_Description',N'部門表',N'Schema',N'dbo',N'table',N'Department',null,null 14 go 15 --為字段添加描述信息 屬性名稱 要添加的屬性信息 級別0 級別0 級別1 級別1 級別2 級別2 16 execute sys.sp_addextendedproperty N'MS_Description',N'部門表ID',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_ID' 17 execute sys.sp_addextendedproperty N'MS_Description',N'部門名稱',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_Name' 18 execute sys.sp_addextendedproperty N'MS_Description',N'鏈接地址',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_Url' 19 execute sys.sp_addextendedproperty N'MS_Description',N'節點圖片地址',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_ImgUrl' 20 execute sys.sp_addextendedproperty N'MS_Description',N'父節點ID',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_ParentID' 21 execute sys.sp_addextendedproperty N'MS_Description',N'部門描述',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_Remark' 22 go
PS: SQL Server 數據庫中的對象分為三個級別:0、1 和 2。 級別 0 是最高級別,2 級為最低。當用戶添加、更新或刪除擴展屬性時,必須指定所有更高級別的對象。例如,當將擴展屬性添加到表列(級別 2)時,還必須指定包含該列的表名(級別 1)以及包含該表的架構(級別 0)。
為表和字段添加了擴展屬性之后,可以使用擴展屬性目錄視圖 sys.extended_properties 查詢到所添加的擴展屬性。
sys.extended_properties 針對當前數據庫中的每個擴展屬性返回一行。
1 --查詢所有的擴展屬性 2 select * from sys.extended_properties 3 4 --查詢指定表的擴展屬性 5 select * from sys.extended_properties where major_id=object_id('Department')
或者還可以使用函數 fn_listextendedproperty 查詢擴展屬性,fn_listextendedproperty 返回數據庫對象的擴展屬性值。
fn_listextendedproperty 語法:
1 fn_listextendedproperty ( 2 { default | 'property_name' | NULL } 3 , { default | 'level0_object_type' | NULL } 4 , { default | 'level0_object_name' | NULL } 5 , { default | 'level1_object_type' | NULL } 6 , { default | 'level1_object_name' | NULL } 7 , { default | 'level2_object_type' | NULL } 8 , { default | 'level2_object_name' | NULL } 9 )
下面是 fn_listextendedproperty 返回的表的格式。
參數同上,使用方法如下:
1 --查詢指定表的所有列的擴展屬性 default 即默認所有列 2 SELECT * FROM fn_listextendedproperty('MS_Description', 'Schema', 'dbo', 'table', 'Department', 'column', default) 3 4 --查詢指定表的指定列的擴展屬性 5 SELECT * FROM fn_listextendedproperty('MS_Description', 'Schema', 'dbo', 'table', 'Department', 'column', 'D_Name')
使用 sp_updateextendedproperty 系統存儲過程修改擴展屬性。
sp_updateextendedproperty 語法:
1 sp_updateextendedproperty 2 [ @name = ]{ 'property_name' } 3 [ , [ @value = ]{ 'value' } 4 [, [ @level0type = ]{ 'level0_object_type' } 5 , [ @level0name = ]{ 'level0_object_name' } 6 [, [ @level1type = ]{ 'level1_object_type' } 7 , [ @level1name = ]{ 'level1_object_name' } 8 [, [ @level2type = ]{ 'level2_object_type' } 9 , [ @level2name = ]{ 'level2_object_name' } 10 ] 11 ] 12 ] 13 ]
0(成功)或 1(失敗)
使用方法示例:
1 --把表 Department 的擴展屬性(表的描述)原值 ‘部門表’改為 ‘部門表測試修改’ 2 execute sp_updateextendedproperty N'MS_Description',N'部門表測試修改',N'Schema',N'dbo',N'table',N'Department',null,null 3 4 --把表 Department 的列 D_Remark 的擴展屬性(列的描述)原值 ‘部門描述’改為 ‘部門詳細描述’ 5 execute sp_updateextendedproperty N'MS_Description',N'部門詳細描述',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_Remark'
使用 sp_dropextendedproperty 系統存儲過程刪除擴展屬性。
sp_dropextendedproperty 語法:
1 sp_dropextendedproperty 2 [ @name = ] { 'property_name' } 3 [ , [ @level0type = ] { 'level0_object_type' } 4 , [ @level0name = ] { 'level0_object_name' } 5 [ , [ @level1type = ] { 'level1_object_type' } 6 , [ @level1name = ] { 'level1_object_name' } 7 [ , [ @level2type = ] { 'level2_object_type' } 8 , [ @level2name = ] { 'level2_object_name' } 9 ] 10 ] 11 ] 12 ]
0(成功)或 1(失敗)
使用方法示例:
1 --刪除表 Department 的擴展屬性(表的描述) 2 execute sp_dropextendedproperty N'MS_Description',N'Schema',N'dbo',N'table',N'Department',null,null 3 4 --刪除表 Department 的列 D_Remark 的擴展屬性(列的描述) 5 execute sp_dropextendedproperty N'MS_Description',N'Schema',N'dbo',N'table',N'Department',N'column',N'D_Remark'
擴展屬性分很多種,添加表和字段的描述只是其中一種擴展屬性,具體請看參考。
參考:
https://technet.microsoft.com/zh-cn/library/ms180047.aspx