sp_dropextendedproperty (Transact-SQL)
適用対象: 
SQL Server
既存の拡張プロパティを削除します。
構文
sp_dropextendedproperty
[ @name = ] N'name'
[ , [ @level0type = ] 'level0type' ]
[ , [ @level0name = ] N'level0name' ]
[ , [ @level1type = ] 'level1type' ]
[ , [ @level1name = ] N'level1name' ]
[ , [ @level2type = ] 'level2type' ]
[ , [ @level2name = ] N'level2name' ]
[ ; ]
引数
[ @name = ] N'name'
削除するプロパティの名前。 @name は sysname であり、 NULLすることはできません。
[ @level0type = ] 'level0type'
指定されたレベル 0 のオブジェクト型の名前。 @level0type は varchar(128) で、既定値は NULL です。
有効な入力は、 ASSEMBLY、 CONTRACT、 EVENT NOTIFICATION、 FILEGROUP、 MESSAGE TYPE、 PARTITION FUNCTION、 PARTITION SCHEME、 REMOTE SERVICE BINDING、 ROUTE、 SCHEMA、 SERVICE、 USER、 TRIGGER、 TYPE、および NULLです。
重要
USER レベル 0 の型としての TYPE は、今後のバージョンの SQL Server で削除される予定です。 新しい開発作業では、これらの機能の使用を避け、現在これらの機能を使用しているアプリケーションは修正するようにしてください。 USERの代わりに、レベル 0 の型としてSCHEMAを使用します。 TYPEの場合は、レベル 0 の種類としてSCHEMAを使用し、レベル 1 の種類としてTYPEします。
[ @level0name = ] N'level0name'
指定されたレベル 0 のオブジェクト型の名前。 @level0name は sysname で、既定値は NULL です。
[ @level1type = ] 'level1type'
レベル 1 オブジェクトの型。 @level1type は varchar(128) で、既定値は NULL です。
有効な入力は、 AGGREGATE、 DEFAULT、 FUNCTION、 LOGICAL FILE NAME、 PROCEDURE、 QUEUE、 RULE、 SYNONYM、 TABLE、 TABLE_TYPE、 TYPE、 VIEW、 XML SCHEMA COLLECTION、および NULLです。
[ @level1name = ] N'level1name'
指定されたレベル 1 のオブジェクト型の名前。 @level1name は sysname で、既定値は NULL です。
[ @level2type = ] 'level2type'
レベル 2 オブジェクトの型。 @level2type は varchar(128) で、既定値は NULL です。
有効な入力は、 COLUMN、 CONSTRAINT、 EVENT NOTIFICATION、 INDEX、 PARAMETER、 TRIGGER、および NULLです。
[ @level2name = ] N'level2name'
指定されたレベル 2 のオブジェクト型の名前。 @level2name は sysname で、既定値は NULL です。
リターン コードの値
0 (成功) または 1 (失敗)。
解説
拡張プロパティを指定すると、SQL Server データベース内のオブジェクトは 0、1、2 の 3 つのレベルに分類されます。 レベル 0 は最上位レベルであり、データベース スコープに含まれるオブジェクトとして定義されます。 レベル 1 のオブジェクトはスキーマ スコープまたはユーザー スコープに含まれ、レベル 2 のオブジェクトはレベル 1 のオブジェクトに含まれます。 これら、どのレベルのオブジェクトに対しても、拡張プロパティを定義できます。 あるレベルのオブジェクトを参照する場合は、その上位レベルにあるすべてのオブジェクトの種類と名前で修飾する必要があります。
有効なプロパティ名 @name指定すると、すべてのオブジェクトの種類と名前が NULL され、現在のデータベースにプロパティが存在する場合、そのプロパティは削除されます。 この記事の後半にある Example B を参照してください。
アクセス許可
db_ownerおよび db_ddladmin 固定データベース ロールのメンバーは、次の例外を除き、オブジェクトの拡張プロパティを削除できます。 db_ddladmin データベース自体またはユーザーまたはロールにプロパティを追加することはできません。
ユーザーは、自分が所有するオブジェクト、または ALTER または CONTROL 権限を持つオブジェクトに対して拡張プロパティを削除できます。
例
A. 列に拡張プロパティを削除する
次の例では、スキーマ caption に含まれるテーブル id 内の列 T1 からプロパティ dbo を削除します。
CREATE TABLE T1 (id INT, name CHAR(20));
GO
EXEC sp_addextendedproperty @name = 'caption',
@value = 'Employee ID',
@level0type = 'SCHEMA',
@level0name = N'dbo',
@level1type = 'TABLE',
@level1name = N'T1',
@level2type = 'COLUMN',
@level2name = N'id';
GO
EXEC sp_dropextendedproperty @name = 'caption',
@level0type = 'SCHEMA',
@level0name = N'dbo',
@level1type = 'TABLE',
@level1name = N'T1',
@level2type = 'COLUMN',
@level2name = N'id';
GO
DROP TABLE T1;
GO
B. データベースの拡張プロパティを削除する
次の例では、AdventureWorks2022 サンプル データベースから MS_Description という名前のプロパティを削除します。 これはデータベース自体のプロパティであり、オブジェクトの種類および名前は指定しません。
USE AdventureWorks2022;
GO
EXEC sp_dropextendedproperty @name = N'MS_Description';
GO