sp_updateextendedproperty (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例

更新现有扩展属性的值。

Transact-SQL 语法约定

语法

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

参数

[ @name = ] N'name'

要更新的属性的名称。 @name为 sysname，无默认值。

[ @value = ] value

与属性关联的值。 @value为sql_variant，默认值为 NULL. 值的大小不能超过 7,500 字节。

[ @level0type = ] 'level0type'

用户或用户定义类型。 @level0type为 varchar（128），默认值为 NULL. 有效输入为：

  • ASSEMBLY
  • CONTRACT
  • EVENT NOTIFICATION
  • FILEGROUP
  • MESSAGE TYPE
  • PARTITION FUNCTION
  • PARTITION SCHEME
  • PLAN GUIDE
  • REMOTE SERVICE BINDING
  • ROUTE
  • SCHEMA
  • SERVICE
  • USER
  • 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. 有效输入为：

  • ASSEMBLY
  • CONTRACT
  • EVENT NOTIFICATION
  • FILEGROUP
  • MESSAGE TYPE
  • PARTITION FUNCTION
  • PARTITION SCHEME
  • PLAN GUIDE
  • REMOTE SERVICE BINDING
  • ROUTE
  • SCHEMA
  • SERVICE
  • USER
  • TRIGGER
  • TYPE
  • NULL

[ @level1name = ] N'level1name'

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

[ @level2type = ] 'level2type'

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

  • COLUMN
  • CONSTRAINT
  • EVENT NOTIFICATION
  • INDEX
  • PARAMETER
  • TRIGGER
  • NULL

[ @level2name = ] N'level2name'

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

返回代码值

0（成功）或 1（失败）。

备注

指定扩展属性时，SQL Server 数据库中的对象分为三个级别（0、1 和 2）。 级别 0 是最高级别，定义为数据库范围中包含的对象。 级别 1 的对象包含在架构作用域或用户作用域中，而级别 2 的对象包含在级别 1 对象中。 可以为这些级别中任一级别的对象定义扩展属性。 引用某个级别中的对象必须用拥有或包含它们的更高级别对象的名称进行限制。

给定有效的 @name 和 @value，如果所有对象类型和名称均为 NULL，则更新的属性属于当前数据库。

权限

db_owner和db_ddladmin固定数据库角色的成员可以更新任何对象的扩展属性，但有以下例外：db_ddladmin无法向数据库本身或用户或角色添加属性。

用户可以将扩展属性更新为他们拥有的对象，或者他们拥有 ALTER 或 CONTROL 权限的对象。

示例

A. 更新列上的扩展属性

以下示例对 Caption 表的 ID 列更新 T1 属性的值。

USE AdventureWorks2022;
GO

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

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

--Update the extended property.
EXEC sp_updateextendedproperty @name = N'Caption',
    @value = 'Employee ID must be unique.',
    @level0type = 'SCHEMA',
    @level0name = N'dbo',
    @level1type = 'TABLE',
    @level1name = N'T1',
    @level2type = 'COLUMN',
    @level2name = N'id';
GO

B. 更新数据库上的扩展属性

以下示例将先对 AdventureWorks2022 示例数据库创建扩展属性，然后更新该属性的值。

USE AdventureWorks2022;
GO

EXEC sp_addextendedproperty @name = N'NewCaption',
    @value = 'AdventureWorks Sample OLTP Database';
GO

USE AdventureWorks2022;
GO

EXEC sp_updateextendedproperty @name = N'NewCaption',
    @value = 'AdventureWorks Sample Database';
GO

相关内容