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, FILEGROUPEVENT NOTIFICATIONPARTITION SCHEMEREMOTE SERVICE BINDINGPARTITION FUNCTIONROUTESCHEMAMESSAGE TYPECONTRACTUSERTRIGGERSERVICETYPEи .NULL

Внимание

USER и TYPE как типы уровня 0 будут удалены в будущей версии SQL Server. Старайтесь не использовать эти функции в новых разработках и предусмотрите соответствующие изменения в приложениях, которые используют их в настоящее время. Вместо него USERиспользуйте SCHEMA тип уровня 0. Для TYPEэтого используйте SCHEMA в качестве типа уровня 0 и TYPE в качестве типа уровня 1.

[ @level0name = ] N'level0name'

Имя указанного типа объекта уровня 0. @level0name — sysname с значением по умолчаниюNULL.

[ @level1type = ] 'level1type'

Тип объекта уровня 1. @level1type — varchar(128) с значением по умолчаниюNULL.

Допустимые входные данные: AGGREGATE, LOGICAL FILE NAMEFUNCTIONRULEQUEUESYNONYMTABLEPROCEDUREDEFAULTTYPEVIEWTABLE_TYPEXML SCHEMA COLLECTIONи .NULL

[ @level1name = ] N'level1name'

Имя указанного типа объекта уровня 1. @level1name — sysname с значением по умолчаниюNULL.

[ @level2type = ] 'level2type'

Тип объекта уровня 2. @level2type — varchar(128) с значением по умолчаниюNULL.

Допустимые входные данные: COLUMN, CONSTRAINT, EVENT NOTIFICATION, INDEXPARAMETER, TRIGGERи NULL.

[ @level2name = ] N'level2name'

Имя указанного типа объекта уровня 2. @level2name имеет имя sysname с значением по умолчаниюNULL.

Значения кода возврата

0 (успешно) или 1 (сбой).

Замечания

При указании расширенных свойств объекты в базе данных SQL Server классифицируются на три уровня: 0, 1 и 2. Уровень 0 является высшим уровнем и определяется как «объекты в области базы данных». Объекты уровня 1 содержатся в схеме и в пользовательской области, а объекты уровня 2 содержатся в объектах уровня 1. Расширенные свойства могут быть определены для объектов на любом из этих уровней. Ссылки на объект определенного уровня должны снабжаться типами и именами всех объектов вышестоящих уровней.

Учитывая допустимое имя свойства @name, если все типы объектов и имена существуют NULL , а свойство существует в текущей базе данных, это свойство удаляется. См . пример B , приведенный далее в этой статье.

Разрешения

Члены db_owner и db_ddladmin предопределенных ролей базы данных могут удалять расширенные свойства любого объекта со следующим исключением: db_ddladmin не могут добавлять свойства в саму базу данных или пользователям или ролям.

Пользователи могут удалять расширенные свойства в объекты, которыми они обладают, или с которыми они имеют ALTER или CONTROL разрешения.

Примеры

А. Удаление расширенного свойства в столбце

В следующем примере удаляется свойство 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

Связанный контент