sp_updateextendedproperty （Transact-SQL）

  • 發行項

適用於：SQL ServerAzure SQL DatabaseAzure 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. 更新數據行上的擴充屬性

下列範例會更新 資料表 T1中數據行 ID 的 屬性值Caption。

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

相關內容