sp_dropextendedproperty (Transact-SQL)

  • 项目

适用于：SQL Server

删除现有的扩展属性。

Transact-SQL 语法约定

语法

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.

有效输入为、、、EVENT NOTIFICATIONPARTITION FUNCTIONMESSAGE TYPESCHEMAPARTITION SCHEMEFILEGROUPROUTEREMOTE SERVICE BINDING、SERVICE、USER、TRIGGER、 TYPE和。NULLCONTRACTASSEMBLY

重要

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.

有效输入为、、、FUNCTIONQUEUETABLELOGICAL FILE NAMERULETABLE_TYPESYNONYMPROCEDURE、TYPE、VIEW、、 XML SCHEMA COLLECTION和。NULLDEFAULTAGGREGATE

[ @level1name = ] N'level1name'

指定的级别 1 对象类型的名称。 @level1name为 sysname，默认值为 NULL.

[ @level2type = ] 'level2type'

级别 2 对象的类型。 @level2type为 varchar（128），默认值为 NULL.

有效输入为 COLUMN、、CONSTRAINT、EVENT NOTIFICATION、INDEXPARAMETER、 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. 删除列上的扩展属性

以下示例从架构 caption 内包含的表 id 中的列 T1 上删除属性 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. 删除数据库上的扩展属性

以下示例从示例数据库中删除名为MS_DescriptionAdventureWorks2022的属性。 由于属性位于数据库本身中，因此不指定对象类型和名称。

USE AdventureWorks2022;
GO

EXEC sp_dropextendedproperty @name = N'MS_Description';
GO

相关内容