sp_updateextendedproperty （Transact-SQL）

發行項
08/21/2023

適用於：SQL Server Azure SQL Database Azure SQL 受控執行個體

更新現有擴充屬性的值。

語法

  
sp_updateextendedproperty  
    [ @name = ]{ 'property_name' }   
    [ , [ @value = ]{ 'value' }  
        [, [ @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。

[ @value= ]{ ' value '}
這是與屬性相關聯的值。值為 SQL_variant ，預設值為 Null。值 的大小 可能不超過 7，500 個位元組。

[ @level0type= ]{ ' level0_object_type '}
這是使用者或使用者定義型別。 level0_object_type為 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。

重要

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

[ @level0name= ]{ ' level0_object_name '}
這是指定的層級 1 物件類型名稱。 level0_object_name 是 預設值為 Null 的 sysname 。

[ @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 是 預設值為 Null 的 sysname 。

[ @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 資料庫中的物件會分類為三個層級（0、1 和 2）。層級 0 是最高層級，且定義為資料庫範圍中包含的物件。層級 1 物件包含在架構或使用者範圍中，而層級 2 物件則由層級 1 物件所包含。擴充屬性可以針對這些層級的任何物件定義。一個層級中物件的參考必須以擁有或包含這些物件之較高層級物件的名稱限定。

假設有有效的 property_name 和值，如果所有物件類型和名稱都是 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 = N'Schema', @level0name = dbo  
    ,@level1type = N'Table',  @level1name = T1  
    ,@level2type = N'Column', @level2name = id;  
GO  
--Update the extended property.  
EXEC sp_updateextendedproperty   
    @name = N'Caption'  
    ,@value = 'Employee ID must be unique.'  
    ,@level0type = N'Schema', @level0name = dbo  
    ,@level1type = N'Table',  @level1name = T1  
    ,@level2type = N'Column', @level2name = 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

另請參閱

Database Engine 預存程式（Transact-SQL）
sys.fn_listextendedproperty （Transact-SQL）
sp_addextendedproperty （Transact-SQL）
sp_dropextendedproperty （Transact-SQL）
sys.extended_properties （Transact-SQL）