sp_dropextendedproperty (Transact-SQL)

卸除現有的擴充屬性。

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 版本中，會移除層級 0 類型的 USER 和 TYPE。 請避免在新的開發工作中使用這些功能，並規劃修改目前使用這些功能的應用程式。 請改用 SCHEMA 來當做層級 0 類型，而不是使用 USER。 如果是 TYPE，請使用 SCHEMA 當做層級 0 類型，並使用 TYPE 當做層級 1 類型。

• [ @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 (失敗)

備註

為了指定擴充屬性，SQL Server 資料庫中的物件會分類成 3 個層級 (0、1 和 2)。 層級 0 是最高層級，定義為資料庫範圍所包含的物件。 層級 1 物件包含在結構描述或使用者範圍中，層級 2 物件包含在層級 1 物件中。 任何這些層級的物件都可以定義擴充屬性。 參考一個層級中的物件時，必須以所有較高層級物件的類型和名稱來限定。

在給定有效的 property_name 之後，如果所有物件類型和名稱都是 NULL，且有屬性存在於目前資料庫，就會刪除這個屬性。 請參閱本主題稍後的範例 B。

權限

除了下列例外狀況，db_owner 和 db_ddladmin 固定資料庫角色的成員可以卸除任何物件的擴充屬性：db_ddladmin 不能將屬性加入至資料庫本身，或加入至使用者或角色中。

使用者可以卸除他們所擁有之物件或他們有 ALTER 或 CONTROL 權限之物件的擴充屬性。

範例

A.卸除資料行的擴充屬性

下列範例會從 dbo 結構描述所包含之 T1 資料表中的資料行 id 中移除 caption 屬性。

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.卸除資料庫的擴充屬性

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

USE AdventureWorks2012;
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)