sp_dropextendedproperty (Transact-SQL)
Удаляет существующие расширенные свойства.
Синтаксические обозначения 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.
Важно!
Типы USER и TYPE уровня 0 будут удалены в будущих версиях SQL Server. Старайтесь не использовать эти функции в новых разработках и предусмотрите соответствующие изменения в приложениях, которые используют эти функции в настоящее время. Тип SCHEMA следует использовать в качестве типа уровня 0 вместо USER. В значении аргумента TYPE следует указывать тип SCHEMA в качестве типа уровня 0 и TYPE в качестве типа уровня 1.
[ @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 распределены по трем уровням: 0, 1 и 2. Уровень 0 является высшим уровнем и определяется как «объекты в области базы данных». Объекты уровня 1 содержатся в схеме и в пользовательской области, а объекты уровня 2 содержатся в объектах уровня 1. Расширенные свойства могут быть определены для объектов на любом из этих уровней. Ссылки на объект определенного уровня должны снабжаться типами и именами всех объектов вышестоящих уровней.
Свойство, заданное допустимым значением property_name, удаляется, если все типы объектов и имена равны нулю и данное свойство существует в текущей базе данных. См. пример Б далее в этом разделе.
Разрешения
Члены предопределенных ролей 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 = 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
Б.Удаление расширенного свойства базы данных
В следующем примере удаляется свойство с именем MS_Description из образца базы данных AdventureWorks2012 . Так как это свойство относится к самой базе данных, типы и имена объектов не указываются.
USE AdventureWorks2012;
GO
EXEC sp_dropextendedproperty
@name = N'MS_Description';
GO
См. также
Справочник
Хранимые процедуры ядра СУБД (Transact-SQL)
sys.fn_listextendedproperty (Transact-SQL)
sp_addextendedproperty (Transact-SQL)
sp_updateextendedproperty (Transact-SQL)
Представление каталога sys.extended_properties (Transact-SQL)