sp_updateextendedproperty (Transact-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'}
  這是與屬性相關聯的值。value 是 sql_variant，預設值是 NULL。value 的大小不能超出 7,500 位元組。

• [@level0type= ]{ 'level0_object_type'}
  這是使用者類型或使用者自訂類型。level0_object_type 是 varchar(128)，預設值是 NULL。有效輸入如下：ASSEMBLY、CONTRACT、EVENT NOTIFICATION、FILEGROUP、MESSAGE TYPE、PARTITION FUNCTION、PARTITION SCHEME、REMOTE SERVICE BINDING、ROUTE、SCHEMA、SERVICE、USER、TRIGGER、TYPE 和 NULL。

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

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

• [@level1type= ]{ 'level1_object_type'}
  這是層級 1 物件的類型。level1_object_type 是 varchar(128)，預設值是 NULL。有效輸入如下：AGGREGATE、DEFAULT、FUNCTION、LOGICAL FILE NAME、PROCEDURE、QUEUE、RULE、SYNONYM、TABLE、TYPE、VIEW、XML SCHEMA COLLECTION 和 NULL。

• [@level1name= ]{ 'level1_object_name'}
  這是指定之層級 1 物件類型的名稱。level1_object_name 是 sysname，預設值是 NULL。

• [@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 資料庫中的物件會分類成 3 個層級 (0、1 和 2)。層級 0 是最高層級，定義為資料庫範圍所包含的物件。層級 1 物件包含在結構描述或使用者範圍中，層級 2 物件包含在層級 1 物件中。任何這些層級的物件都可以定義擴充屬性。對一個層級中物件的參考，必須用擁有或包含它們的較高層級物件的名稱來限定。如需物件及有效層級 0、1 和 2 類型的完整清單，請參閱＜使用資料庫物件的擴充屬性＞。

在給定有效的 property_name 和 value 之後，如果所有物件類型和名稱都是 NULL，則更新的屬性會屬於目前資料庫。

權限

除了下列例外狀況，db_owner 和 db_ddladmin 固定資料庫角色的成員可以更新任何物件的擴充屬性：db_ddladmin 不能將屬性加入至資料庫本身，或加入至使用者或角色中。

使用者可以更新他們所擁有之物件，或他們有 ALTER 或 CONTROL 權限之物件的擴充屬性。如需必要權限的完整清單，請參閱＜使用資料庫物件的擴充屬性＞。

範例

A. 更新資料行的擴充屬性

USE AdventureWorks;
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. 更新資料庫的擴充屬性

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

請參閱

參考

概念