sp_updateextendedproperty (Transact-SQL)
適用対象: 
SQL Server Azure SQL Database Azure SQL Managed Instance
既存の拡張プロパティの値を更新します。
構文
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 です。 valueのサイズは 7,500 バイトを超えることはできません。
[ @level0type = ] 'level0type'
ユーザー定義型またはユーザー定義型。 @level0type は varchar(128) で、既定値は NULL です。 有効な入力は次のとおりです。
ASSEMBLYCONTRACTEVENT NOTIFICATIONFILEGROUPMESSAGE TYPEPARTITION FUNCTIONPARTITION SCHEMEPLAN GUIDEREMOTE SERVICE BINDINGROUTESCHEMASERVICEUSERTRIGGERTYPENULL
重要
USERレベル 0 としてTYPE型は、今後のバージョンの SQL Server で削除される予定です。 新しい開発作業では、これらの機能の使用を避け、現在これらの機能を使用しているアプリケーションは修正するようにしてください。 USERの代わりに、SCHEMAを level 0 型として使用します。 TYPEの場合は、SCHEMAを level 0 型として使用し、レベル 1 型としてTYPEします。
[ @level0name = ] N'level0name'
指定されたレベル 0 のオブジェクト型の名前。 @level0name は sysname で、既定値は NULL です。
[ @level1type = ] 'level1type'
レベル 1 オブジェクトの型。 @level1type は varchar(128) で、既定値は NULL です。 有効な入力は次のとおりです。
ASSEMBLYCONTRACTEVENT NOTIFICATIONFILEGROUPMESSAGE TYPEPARTITION FUNCTIONPARTITION SCHEMEPLAN GUIDEREMOTE SERVICE BINDINGROUTESCHEMASERVICEUSERTRIGGERTYPENULL
[ @level1name = ] N'level1name'
指定されたレベル 1 のオブジェクト型の名前。 @level1name は sysname で、既定値は NULL です。
[ @level2type = ] 'level2type'
レベル 2 オブジェクトの型。 @level2type は varchar(128) で、既定値は NULL です。 有効な入力は次のとおりです。
COLUMNCONSTRAINTEVENT NOTIFICATIONINDEXPARAMETERTRIGGERNULL
[ @level2name = ] N'level2name'
指定されたレベル 2 のオブジェクト型の名前。 @level2name は sysname で、既定値は NULL です。
リターン コードの値
0 (成功) または 1 (失敗)。
解説
拡張プロパティを指定すると、SQL Server データベース内のオブジェクトは 3 つのレベル (0、1、2) に分類されます。 レベル 0 は最上位レベルであり、データベース スコープに含まれるオブジェクトとして定義されます。 レベル 1 のオブジェクトはスキーマ スコープまたはユーザー スコープに含まれ、レベル 2 のオブジェクトはレベル 1 のオブジェクトに含まれます。 これら、どのレベルのオブジェクトに対しても、拡張プロパティを定義できます。 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