sp_dropextendedproperty (Transact-SQL)

更新 : 2005 年 12 月 5 日

既存の拡張プロパティを削除します。

Transact-SQL 構文表記規則

構文

sp_dropextendedproperty 
    [ @name = ] { 'property_name' }
      [ , [ @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 を指定することはできません。

• [ @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、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 です。

解説

拡張プロパティを指定するために、SQL Server データベース内のオブジェクトは、3 つのレベル (0、1、2) に分けられています。レベル 0 は、データベース スコープに含まれる最上位レベルのオブジェクトとして定義されます。レベル 1 のオブジェクトはスキーマまたはユーザー スコープに含まれ、レベル 2 のオブジェクトはレベル 1 のオブジェクトに含まれます。これら、どのレベルのオブジェクトに対しても、拡張プロパティを定義できます。あるレベルのオブジェクトを参照する場合は、その上位レベルにあるすべてのオブジェクトの種類と名前で修飾する必要があります。

有効な property_name が与えられていて、すべてのオブジェクトの種類とオブジェクト名が NULL で、現在のデータベース上にプロパティが存在する場合、そのプロパティは削除されます。次の例 B を参照してください。

権限

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

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

戻り値

成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。

例

A. 列の拡張プロパティを削除する

次の例では、スキーマ dbo に含まれるテーブル T1 内の列 id からプロパティ 'caption' を削除します。

CREATE TABLE T1 (id int , name char (20));
GO
EXEC sp_addextendedproperty 
    @name = 'caption' 
    ,@value = 'Employee ID' 
    ,@level0type = 'schema' 
    ,@level0name = dbo
    ,@level1type = 'table'
    ,@level1name = 'T1'
    ,@level2type = 'column'
    ,@level2name = id;
GO
EXEC sp_dropextendedproperty 
     @name = 'caption' 
    ,@level0type = 'schema' 
    ,@level0name = dbo
    ,@level1type = 'table'
    ,@level1name = 'T1'
    ,@level2type = 'column'
    ,@level2name = id;
GO
DROP TABLE T1;
GO

B. データベースの拡張プロパティを削除する

次の例では、AdventureWorks サンプル データベースから MS_Description という名前のプロパティを削除します。これはデータベース自体のプロパティであり、オブジェクトの種類および名前は指定しません。

USE AdventureWorks;
GO
EXEC sp_dropextendedproperty 
@name = N'MS_Description';
GO

参照

関連項目

データベース エンジンのストアド プロシージャ (Transact-SQL)
fn_listextendedproperty (Transact-SQL)
sp_addextendedproperty (Transact-SQL)
sp_updateextendedproperty (Transact-SQL)
sys.extended_properties (Transact-SQL)

その他の技術情報

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

ヘルプおよび情報

SQL Server 2005 の参考資料の入手

変更履歴