sp_dropextendedproperty (Transact-SQL)

適用於:SQL Server

卸載現有的擴充屬性。

Transact-SQL 語法慣例

語法

  
sp_dropextendedproperty   
    [ @name = ] { 'property_name' }  
      [ , [ @level0type = ] { 'level0_object_type' }   
        , [ @level0name = ] { 'level0_object_name' }   
            [ , [ @level1type = ] { 'level1_object_type' }   
              , [ @level1name = ] { 'level1_object_name' }   
                [ , [ @level2type = ] { 'level2_object_type' }   
                  , [ @level2name = ] { 'level2_object_name' }   
                ]   
            ]   
        ]   
    ]   

引數

[ @name= ]{ ' property_name '}
這是要卸載的屬性名稱。 property_name為 sysname ,不能為 Null。

[ @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 和 Null。

重要

未來的 SQL Server 版本將會移除 USER 和 TYPE 作為層級 0 類型。 請避免在新的開發工作中使用這些功能,並規劃修改目前使用這些功能的應用程式。 使用 SCHEMA 作為層級 0 類型,而不是 USER。 針對 TYPE,請使用 SCHEMA 作為層級 0 類型,並使用 TYPE 作為層級 1 類型。

[ @level0name= ]{ ' level0_object_name '}
這是指定的層級 0 物件類型名稱。 level0_object_name 預設值為 Null 的 sysname

[ @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 預設值為 Null 的 sysname

[ @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是 預設值為 Null 的 sysname

傳回碼值

0 (成功) 或 1 (失敗)

備註

為了指定擴充屬性的目的,SQL Server 資料庫中的物件會分類為三個層級:0、1 和 2。 層級 0 是最高層級,且定義為資料庫範圍中包含的物件。 層級 1 物件包含在架構或使用者範圍中,而層級 2 物件則由層級 1 物件所包含。 擴充屬性可以針對這些層級的任何物件定義。 一個層級中物件的參考必須以所有較高層級物件的類型和名稱限定。

假設有有效的 property_name ,如果所有物件類型和名稱都是 null,而且目前資料庫上有屬性,則會刪除該屬性。 請參閱本主題稍後的範例 B。

權限

db_owner和db_ddladmin固定資料庫角色的成員可能會卸載任何物件的擴充屬性,但有下列例外:db_ddladmin可能不會將屬性新增至資料庫本身或使用者或角色。

使用者可以將擴充屬性卸載至他們擁有的物件,或擁有 ALTER 或 CONTROL 許可權的物件。

範例

A. 卸載資料行上的擴充屬性

下列範例會從架構 中包含的資料表 T1 中的資料行 id 中移除 屬性 captiondbo

CREATE TABLE T1 (id int , name char (20));  
GO  
EXEC sp_addextendedproperty   
     @name = 'caption'   
    ,@value = 'Employee ID'   
    ,@level0type = 'schema'   
    ,@level0name = dbo  
    ,@level1type = 'table'  
    ,@level1name = 'T1'  
    ,@level2type = 'column'  
    ,@level2name = id;  
GO  
EXEC sp_dropextendedproperty   
     @name = 'caption'   
    ,@level0type = 'schema'   
    ,@level0name = dbo  
    ,@level1type = 'table'  
    ,@level1name = 'T1'  
    ,@level2type = 'column'  
    ,@level2name = id;  
GO  
DROP TABLE T1;  
GO  

B. 卸載資料庫上的擴充屬性

下列範例會從 AdventureWorks2022 範例資料庫移除名為 MS_Description 的屬性。 由於 屬性位於資料庫本身上,因此不會指定任何物件類型和名稱。

USE AdventureWorks2022;  
GO  
EXEC sp_dropextendedproperty   
@name = N'MS_Description';  
GO  

另請參閱

Database Engine 預存程式 (Transact-SQL)
sys.fn_listextendedproperty (Transact-SQL)
sp_addextendedproperty (Transact-SQL)
sp_updateextendedproperty (Transact-SQL)
sys.extended_properties (Transact-SQL)