sp_updateextendedproperty (Transact-SQL)

既存の拡張プロパティの値を更新します。

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 です。

  重要
  レベル 0 のオブジェクトの種類である USER および TYPE は、SQL Server の今後のバージョンで削除される予定です。 新しい開発作業では、これらの機能の使用を避け、現在これらの機能を使用しているアプリケーションは修正するようにしてください。 USER の代わりに、レベル 0 の種類として SCHEMA を使用してください。 TYPE については、レベル 0 の種類として SCHEMA、レベル 1 の種類として TYPE を使用してください。

• [ @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 のオブジェクトに含まれます。 これら、どのレベルのオブジェクトに対しても、拡張プロパティを定義できます。 1 つのレベルにあるオブジェクトを参照する場合は、そのオブジェクトを所有または格納する上位レベルのオブジェクトの名前で修飾する必要があります。

有効な property_name と value が指定されていて、すべてのオブジェクトの種類および名前が NULL である場合、更新されたプロパティは現在のデータベースに属します。

権限

固定サーバー ロール db_owner および db_ddladmin のメンバーは、任意のオブジェクトの拡張プロパティを更新する場合があります。ただし、例外として、db_ddladmin はデータベース自体、ユーザー、またはロールにプロパティを追加しない場合があります。

ユーザーは、自身が所有するオブジェクト、および ALTER 権限または CONTROL 権限を持つオブジェクトの拡張プロパティを更新できます。

使用例

A. 列の拡張プロパティを更新する

次の例では、T1 テーブルの ID 列の Caption プロパティの値を更新します。

USE AdventureWorks2012;
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. データベースの拡張プロパティを更新する

次の例では、まず AdventureWorks2012 サンプル データベースに拡張プロパティを作成し、次にそのプロパティの値を更新します。

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

関連項目

参照

データベース エンジンのストアド プロシージャ (Transact-SQL)

sys.fn_listextendedproperty (Transact-SQL)

sp_addextendedproperty (Transact-SQL)

sp_dropextendedproperty (Transact-SQL)

sys.extended_properties (Transact-SQL)