sp_addextendedproperty (Transact-SQL)

新しい拡張プロパティをデータベース オブジェクトに追加します。

Transact-SQL 構文表記規則

構文

sp_addextendedproperty
    [ @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'}
  レベル 0 のオブジェクトの種類です。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'}
  指定したレベル 0 のオブジェクトの種類の名前です。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、TABLE_TYPE、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 つのレベルにあるオブジェクトを参照する場合は、そのオブジェクトを所有または格納する上位レベルのオブジェクトの名前で修飾する必要があります。たとえば、拡張プロパティをテーブル列 (レベル 2) に追加する場合、その列を含むテーブル名 (レベル 1) とそのテーブルを含むスキーマ (レベル 0) も指定する必要があります。

オブジェクトの種類とその有効レベル (0、1、2) の一覧については、「データベース オブジェクトでの拡張プロパティの使用」を参照してください。

すべてのオブジェクトの種類および名前が NULL である場合、プロパティは現在のデータベースそのものに属します。

拡張プロパティは、システム オブジェクト、ユーザー定義データベースのスコープ外のオブジェクト、または「引数」で有効な入力として示されないオブジェクトでは使用できません。

拡張プロパティのレプリケート

拡張プロパティは、パブリッシャとサブスクライバ間で初期同期を実行するときにのみレプリケートされます。初期同期の完了後に拡張プロパティを追加または変更した場合、その変更はレプリケートされません。データベース オブジェクトのレプリケート方法の詳細については、「データとデータベース オブジェクトのパブリッシュ」を参照してください。

スキーマとユーザー

名前解決にあいまいさが発生する可能性があるため、拡張プロパティをデータベース オブジェクトに適用するときに USER をレベル 0 の種類として指定することをお勧めしません。たとえば、ユーザー Mary が 2 つのスキーマ (Mary と MySchema) を所有し、これらのスキーマの両方に MyTable という名前のテーブルがある場合を考えます。Mary が拡張プロパティをテーブル MyTable に追加し、@level0type = N'USER'、@level0name = Mary と指定した場合、拡張プロパティの適用先がどちらのテーブルであるかが明確ではなくなります。旧バージョンとの互換性を維持するために、SQL Server では Mary という名前のスキーマに含まれているテーブルにプロパティが適用されます。ユーザーとスキーマの詳細については、「ユーザーとスキーマの分離」を参照してください。

権限

固定サーバー ロール db_owner および db_ddladmin のメンバは、任意のオブジェクトに拡張プロパティを追加できます。ただし、例外として、db_ddladmin はデータベース自体、ユーザー、またはロールにプロパティを追加できません。

ユーザーは、自身が所有するオブジェクトや、ALTER 権限または CONTROL 権限を持つオブジェクトの拡張プロパティを追加できます。必要な権限の一覧については、「データベース オブジェクトでの拡張プロパティの使用」を参照してください。

例

A. 拡張プロパティをデータベースに追加する

次の例では、値 'AdventureWorks Sample OLTP Database' を持つプロパティ名 'Caption' を AdventureWorks サンプル データベースに追加します。

USE AdventureWorks;
GO
--Add a caption to the AdventureWorks Database object itself.
EXEC sp_addextendedproperty 
@name = N'Caption', @value = 'AdventureWorks Sample OLTP Database';

B. 拡張プロパティをテーブル内の列に追加する

次の例では、テーブル Address 内の列 PostalCode にタイトルのプロパティを追加します。

USE AdventureWorks;
GO
EXEC sp_addextendedproperty 
@name = N'Caption', @value = 'Postal code is a required column.',
@level0type = N'Schema', @level0name = Person,
@level1type = N'Table',  @level1name = Address,
@level2type = N'Column', @level2name = PostalCode;
GO

C. 定型入力プロパティを列に追加する

次の例では、定型入力プロパティ '99999 or 99999-9999 or #### ###' をテーブル Address 内の列 PostalCode に追加します。

USE AdventureWorks;
GO
EXEC sp_addextendedproperty 
@name = N'Input Mask ', @value = '99999 or 99999-9999 or #### ###',
@level0type = N'Schema', @level0name = Person,
@level1type = N'Table', @level1name = Address, 
@level2type = N'Column',@level2name = PostalCode;
GO

D. 拡張プロパティをファイル グループに追加する

次の例では、拡張プロパティを PRIMARY ファイル グループに追加します。

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Primary filegroup for the AdventureWorks sample database.', 
@level0type = N'FILEGROUP', @level0name = [PRIMARY];
GO

関連項目

参照

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

fn_listextendedproperty (Transact-SQL)

sp_dropextendedproperty (Transact-SQL)

sp_updateextendedproperty (Transact-SQL)

概念

データベース オブジェクトでの拡張プロパティの使用

拡張プロパティの表示