sp_dropextendedproperty (Transact-SQL)sp_dropextendedproperty (Transact-SQL)

ОБЛАСТЬ ПРИМЕНЕНИЯ: даSQL Server нетБаза данных SQL Azure нетAzure Synapse Analytics (хранилище данных SQL) нетParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Удаляет существующие расширенные свойства.Drops an existing extended property.

Значок ссылки на раздел Синтаксические обозначения в Transact-SQLTopic link icon Transact-SQL Syntax Conventions

СинтаксисSyntax

  
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' }   
                ]   
            ]   
        ]   
    ]   

АргументыArguments

[ @name=] {"property_name"}[ @name= ]{ 'property_name'}
Имя свойства, которое необходимо удалить.Is the name of the property to be dropped. property_namesysname и не может иметь значение NULL.property_name is sysname and cannot be NULL.

[ @level0type=] {"level0_object_type"}[ @level0type= ]{ 'level0_object_type'}
Имя указанного типа объекта уровня 0.Is the name of the level 0 object type specified. level0_object_typevarchar(128) , значение по умолчанию NULL.level0_object_type is varchar(128), with a default of NULL.

Допустимые входные данные: ASSEMBLY, CONTRACT, EVENT NOTIFICATION, FILEGROUP, MESSAGE TYPE, PARTITION FUNCTION, PARTITION SCHEME, REMOTE SERVICE BINDING, ROUTE, SCHEMA, SERVICE, USER, TRIGGER, TYPE и NULL.Valid inputs are ASSEMBLY, CONTRACT, EVENT NOTIFICATION, FILEGROUP, MESSAGE TYPE, PARTITION FUNCTION, PARTITION SCHEME, REMOTE SERVICE BINDING, ROUTE, SCHEMA, SERVICE, USER, TRIGGER, TYPE, and NULL.

Важно!

Типы USER и TYPE уровня 0 будут удалены в будущих версиях SQL ServerSQL Server.USER and TYPE as level-0 types will be removed in a future version of SQL ServerSQL Server. Старайтесь не использовать эти функции в новых разработках и предусмотрите соответствующие изменения в приложениях, которые используют их в настоящее время.Avoid using these features in new development work, and plan to modify applications that currently use these features. Тип SCHEMA следует использовать в качестве типа уровня 0 вместо USER.Use SCHEMA as the level 0 type instead of USER. В значении аргумента TYPE следует указывать тип SCHEMA в качестве типа уровня 0 и TYPE в качестве типа уровня 1.For TYPE, use SCHEMA as the level 0 type and TYPE as the level 1 type.

[ @level0name=] {"level0_object_name"}[ @level0name= ]{ 'level0_object_name'}
Имя указанного типа объекта уровня 0.Is the name of the level 0 object type specified. level0_object_namesysname значение по умолчанию NULL.level0_object_name is sysname with a default of NULL.

[ @level1type=] {"level1_object_type"}[ @level1type= ]{ 'level1_object_type'}
Тип объекта уровня 1.Is the type of level 1 object. level1_object_typevarchar(128) значение по умолчанию NULL.level1_object_type is varchar(128) with a default of NULL. Допустимые входные данные: AGGREGATE, DEFAULT, FUNCTION, LOGICAL FILE NAME, PROCEDURE, QUEUE, RULE, SYNONYM, TABLE, TABLE_TYPE, TYPE, VIEW, XML SCHEMA COLLECTION и NULL.Valid inputs are AGGREGATE, DEFAULT, FUNCTION, LOGICAL FILE NAME, PROCEDURE, QUEUE, RULE, SYNONYM, TABLE, TABLE_TYPE, TYPE, VIEW, XML SCHEMA COLLECTION, and NULL.

[ @level1name=] {"level1_object_name"}[ @level1name= ]{ 'level1_object_name'}
Имя указанного типа объекта уровня 1.Is the name of the level 1 object type specified. level1_object_namesysname значение по умолчанию NULL.level1_object_name is sysname with a default of NULL.

[ @level2type=] {"level2_object_type"}[ @level2type= ]{ 'level2_object_type'}
Тип объекта уровня 2.Is the type of level 2 object. level2_object_typevarchar(128) значение по умолчанию NULL.level2_object_type is varchar(128) with a default of NULL. Допустимые входные данные: COLUMN, CONSTRAINT, EVENT NOTIFICATION, INDEX, PARAMETER, TRIGGER и NULL.Valid inputs are COLUMN, CONSTRAINT, EVENT NOTIFICATION, INDEX, PARAMETER, TRIGGER, and NULL.

[ @level2name=] {"level2_object_name"}[ @level2name= ]{ 'level2_object_name'}
Имя указанного типа объекта уровня 2.Is the name of the level 2 object type specified. level2_object_namesysname значение по умолчанию NULL.level2_object_name is sysname with a default of NULL.

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

0 (успешное завершение) или 1 (неуспешное завершение)0 (success) or 1 (failure)

ПримечанияRemarks

С целью указания расширенных свойств объекты в SQL ServerSQL Server базы данных, делятся на три уровня: 0, 1 и 2.For the purpose of specifying extended properties, the objects in a SQL ServerSQL Server database are classified into three levels: 0, 1, and 2. Уровень 0 является высшим уровнем и определяется как «объекты в области базы данных».Level 0 is the highest level and is defined as objects contained at the database scope. Объекты уровня 1 содержатся в схеме и в пользовательской области, а объекты уровня 2 содержатся в объектах уровня 1.Level 1 objects are contained in a schema or user scope, and level 2 objects are contained by level 1 objects. Расширенные свойства могут быть определены для объектов на любом из этих уровней.Extended properties can be defined for objects at any of these levels. Ссылки на объект определенного уровня должны снабжаться типами и именами всех объектов вышестоящих уровней.References to an object in one level must be qualified with the types and names of all higher level objects.

Задан допустимый property_name, если все типы и имена объектов имеют значение null, и свойство существует в текущей базе данных, что свойство удаляется.Given a valid property_name, if all object types and names are null and a property exists on the current database, that property is deleted. См. пример Б далее в этом разделе.See example B that follows later in this topic.

РазрешенияPermissions

Члены предопределенной роли базы данных db_ddladmin и db_owner могут удалять расширенные свойства любого объекта за следующим исключением: db_ddladmin не могут добавлять свойства к самой базе данных, пользователям или ролям.Members of the db_owner and db_ddladmin fixed database roles may drop extended properties of any object with the following exception: db_ddladmin may not add properties to the database itself, or to users or roles.

Пользователи могут удалять расширенные свойства объектов, которыми они владеют или на которые у них есть разрешения ALTER или CONTROL.Users may drop extended properties to objects they own or on which they have ALTER or CONTROL permissions.

ПримерыExamples

A.A. Удаление расширенного свойства столбцаDropping an extended property on a column

В следующем примере удаляется свойство caption столбца id таблицы T1, находящейся в схеме dbo.The following example removes the property caption from column id in table T1 contained in the schema 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  

Б.B. Удаление расширенного свойства базы данныхDropping an extended property on a database

В следующем примере удаляется свойство с именем MS_Description из AdventureWorks2012AdventureWorks2012 образца базы данных.The following example removes the property named MS_Description from the AdventureWorks2012AdventureWorks2012 sample database. Так как это свойство относится к самой базе данных, типы и имена объектов не указываются.Because the property is on the database itself, no object types and names are specified.

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

См. такжеSee Also

Хранимым процедурам ядра СУБД (Transact-SQL) Database Engine Stored Procedures (Transact-SQL)
sys.fn_listextendedproperty (Transact-SQL) sys.fn_listextendedproperty (Transact-SQL)
sp_addextendedproperty (Transact-SQL) sp_addextendedproperty (Transact-SQL)
sp_updateextendedproperty (Transact-SQL) sp_updateextendedproperty (Transact-SQL)
sys.extended_properties (Transact-SQL)sys.extended_properties (Transact-SQL)