sp_dropextendedproperty (Transact-SQL)

  • [アーティクル]

適用対象:SQL Server

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

Transact-SQL 構文表記規則

構文

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 レベル TYPE 0 の型は、今後のバージョンの SQL Server で削除される予定です。 新しい開発作業では、これらの機能の使用を避け、現在これらの機能を使用しているアプリケーションは修正するようにしてください。 の代わりにUSERレベル 0 の型として使用SCHEMAします。 の場合TYPEは、レベル 0 の種類として、レベル TYPE 1 の種類として使用SCHEMAします。

[ @level0name = ] N'level0name'

指定されたレベル 0 のオブジェクト型の名前。 @level0nameは sysname で、既定値は NULL.

[ @level1type = ] 'level1type'

レベル 1 オブジェクトの型。 @level1typeは varchar(128) で、既定値は NULL.

有効な入力は、, DEFAULT, , FUNCTION, , LOGICAL FILE NAME, PROCEDURE, QUEUE, RULE, SYNONYM, TABLE, TABLE_TYPE, TYPE, , VIEW, , XML SCHEMA COLLECTION.NULLAGGREGATE

[ @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 、現在のデータベースにプロパティが存在する場合、そのプロパティは削除されます。 この記事で後述する例 B を参照してください。

アクセス許可

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

ユーザーは、自分が所有するオブジェクト、または所有しているオブジェクトまたは権限を持つALTERCONTROLオブジェクトに対して拡張プロパティを削除できます。

例

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. データベースの拡張プロパティを削除する

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

USE AdventureWorks2022;
GO

EXEC sp_dropextendedproperty @name = N'MS_Description';
GO

関連するコンテンツ