sp_dropextendedproperty （Transact-SQL）

發行項
2025-01-02

適用於：SQL Server

卸除現有的擴充屬性。

語法

sp_dropextendedproperty
    [ @name = ] N'name'
    [ , [ @level0type = ] 'level0type' ]
    [ , [ @level0name = ] N'level0name' ]
    [ , [ @level1type = ] 'level1type' ]
    [ , [ @level1name = ] N'level1name' ]
    [ , [ @level2type = ] 'level2type' ]
    [ , [ @level2name = ] N'level2name' ]
[ ; ]

引數

[ @name = ] N'name'

要卸除的屬性名稱。 @name是 sysname，而且不能是 NULL。

[ @level0type = ] 'level0type'

指定之層級0物件類型的名稱。 @level0type為 varchar（128），預設值為 NULL。

有效的輸入為ASSEMBLY、CONTRACT、FILEGROUPPARTITION FUNCTIONREMOTE SERVICE BINDINGSERVICEEVENT NOTIFICATIONPARTITION SCHEMEROUTEMESSAGE TYPESCHEMAUSER、TRIGGER、 TYPE和。NULL

重要

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

[ @level0name = ] N'level0name'

指定之層級0物件類型的名稱。 @level0name為 sysname 預設值為 NULL。

[ @level1type = ] 'level1type'

層級 1 物件的類型。 @level1type為 varchar（128），預設值為 NULL。

有效的輸入為AGGREGATE、、DEFAULTSYNONYMTABLEFUNCTIONRULEQUEUELOGICAL FILE NAMEPROCEDURE、、TYPETABLE_TYPE、、 VIEWXML SCHEMA COLLECTION和。NULL

[ @level1name = ] N'level1name'

指定之層級 1 物件類型的名稱。 @level1name為 sysname，預設值為 NULL。

[ @level2type = ] 'level2type'

層級 2 物件的類型。 @level2type為 varchar（128），預設值為 NULL。

有效的輸入為COLUMN、、CONSTRAINT、EVENT NOTIFICATIONINDEX、PARAMETER、、 TRIGGER和 NULL。

[ @level2name = ] N'level2name'

指定之層級 2 物件類型的名稱。 @level2name為 sysname，預設值為 NULL。

傳回碼值

0 (成功) 或 1 (失敗)。

備註

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

假設有有效的屬性名稱 @name，如果所有物件類型和名稱都存在 NULL ，而且目前資料庫上有屬性，則會刪除該屬性。請參閱本文稍後的範例 B 。

權限

db_owner和 db_ddladmin 固定資料庫角色的成員可以卸除任何對象的擴充屬性，但有下列例外狀況： db_ddladmin 無法將屬性新增至資料庫本身或使用者或角色。

用戶可以將擴充屬性卸除至他們擁有的物件，或擁有 ALTER 或 CONTROL 許可權的物件。

範例

A. 卸除數據行上的擴充屬性

下列範例會從架構中包含的數據表T1中的數據行id中移除屬性caption。dbo

CREATE TABLE T1 (id INT, name CHAR(20));
GO

EXEC sp_addextendedproperty @name = 'caption',
    @value = 'Employee ID',
    @level0type = 'SCHEMA',
    @level0name = N'dbo',
    @level1type = 'TABLE',
    @level1name = N'T1',
    @level2type = 'COLUMN',
    @level2name = N'id';
GO

EXEC sp_dropextendedproperty @name = 'caption',
    @level0type = 'SCHEMA',
    @level0name = N'dbo',
    @level1type = 'TABLE',
    @level1name = N'T1',
    @level2type = 'COLUMN',
    @level2name = N'id';
GO

DROP TABLE T1;
GO

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

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

USE AdventureWorks2022;
GO

EXEC sp_dropextendedproperty @name = N'MS_Description';
GO

共用方式為