sp_addextendedproperty (Transact-SQL)

Применимо к: SQL Server (все поддерживаемые версии) Azure SQL базы данных Управляемый экземпляр SQL Azure

Добавляет к объекту базы данных новое расширенное свойство.
безопасность

Topic link iconСинтаксические обозначения в Transact-SQL

Синтаксис

  
sp_addextendedproperty  
    [ @name = ] { 'property_name' }  
    [ , [ @value = ] { 'value' }   
        [ , [ @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. Имена могут также включать пустые или не являющиеся алфавитно-цифровыми строки символов, а также двоичные значения.

[ @value= ] { 'value'}
Значение, связываемое со свойством. значение равно sql_variant со значением по умолчанию NULL. Размер аргумента value не может превышать 7 500 байт.

[ @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, PLAN GUIDE и NULL.

Важно!

Возможность указать USER в качестве типа уровня 0 в расширенном свойстве объекта типа уровня 1 будет удалена в будущей версии SQL Server. Используйте вместо этого в качестве типа уровня 0 схему (SCHEMA). Например, при определении расширенного свойства таблицы задайте схему таблицы вместо имени пользователя. Возможность указать тип TYPE в качестве типа level-0 будет удалена в будущей версии SQL Server. В значении аргумента TYPE следует указывать тип SCHEMA в качестве типа уровня 0 и TYPE в качестве типа уровня 1.

[ @level0name= ] { 'level0_object_name' }
Имя указанного типа объекта уровня 0. level0_object_namesysname со значением по умолчанию NULL.

[ @level1type= ] { 'level1_object_type' }
Тип объекта уровня 1. level1_object_type имеет значение varchar(128) со значением NULL. Допустимые входные данные: AGGREGATE, DEFAULT, FUNCTION, LOGICAL FILE NAME, PROCEDURE, QUEUE, RULE, SEQUENCE, SYNONYM, TABLE, TABLE_TYPE, TYPE, VIEW, XML SCHEMA COLLECTION и NULL.
[ @level1name= ] { 'level1_object_name' }
Имя указанного типа объекта уровня 1. level1_object_namesysname с значением по умолчанию NULL.

[ @level2type= ] { 'level2_object_type' }
Тип объекта уровня 2. level2_object_typevarchar(128), значение по умолчанию равно NULL. Допустимые входные данные: COLUMN, CONSTRAINT, EVENT NOTIFICATION, INDEX, PARAMETER, TRIGGER и NULL.

[ @level2name= ] { 'level2_object_name' }
Имя указанного типа объекта уровня 2. level2_object_namesysname с значением по умолчанию NULL.

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

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

Remarks

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

Ссылки на объект определенного уровня должны быть уточнены именами объектов более высокого уровня, в которых они содержатся или которым они принадлежат. Например, при добавлении расширенного свойства к столбцу таблицы (уровень 2) необходимо также задать имя таблицы (уровень 1), содержащей этот столбец, а также схему (уровень 0), содержащую таблицу.

Если значения всех типов и имен объектов равны NULL, свойство считается принадлежащим собственно текущей базе данных.

Для системных объектов, объектов вне области пользовательской базы данных, а также для объектов, не перечисленных в качестве допустимых входных параметров в списке аргументов, расширенные свойства недоступны.

Расширенные свойства не допускаются в таблицах, оптимизированных для памяти.

Репликация расширенных свойств

Расширенные свойства реплицируются только во время начальной синхронизации между издателем и подписчиком. При добавлении или изменении расширенного свойства после начальной синхронизации эти изменения не реплицируются. Дополнительные сведения о репликации объектов базы данных см. в разделе "Публикация данных" и "Объекты базы данных".

Схема и Пользователь

Не рекомендуется указывать тип USER в качестве типа уровня 0 при применении расширенного свойства к объекту базы данных, так как это может вызвать неоднозначность при разрешении имен. Например, предположим, что пользователь Владимир владеет двумя схемами (Vladimir и MySchema) и в обеих этих схемах содержится таблица с именем MyTable. Если Мэри добавляет расширенное свойство в таблицу MyTable и указывает @level0type = N'USER, @level0name = Mary, то не ясно, к какой таблице применяется расширенное свойство. Чтобы обеспечить обратную совместимость, SQL Server применит свойство к таблице, содержащейся в схеме с именем Mary.

Разрешения

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

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

Примеры

A. Добавление расширенного свойства к базе данных

В следующем примере к образцу базы данных 'Caption' добавляется свойство с именем 'AdventureWorks2012 Sample OLTP Database' и значением AdventureWorks2012 .

USE AdventureWorks2012;  
GO  
--Add a caption to the AdventureWorks2012 Database object itself.  
EXEC sp_addextendedproperty   
@name = N'Caption',   
@value = 'AdventureWorks2012 Sample OLTP Database';  

Б. Добавление расширенного свойства к столбцу в таблице

В следующем примере свойство Caption добавляется к столбцу PostalCode в таблице Address.

USE AdventureWorks2012;  
GO  
EXEC sp_addextendedproperty   
@name = N'Caption',   
@value = 'Postal code is a required column.',  
@level0type = N'Schema', @level0name = 'Person',  
@level1type = N'Table',  @level1name = 'Address',  
@level2type = N'Column', @level2name = 'PostalCode';  
GO  

В. Добавление свойства маски ввода к столбцу

В следующем примере к столбцу99999 or 99999-9999 or #### ###в таблице PostalCode добавляется свойство маски ввода ' Address'.

USE AdventureWorks2012;  
GO  
EXEC sp_addextendedproperty   
@name = N'Input Mask ', @value = '99999 or 99999-9999 or #### ###',  
@level0type = N'Schema', @level0name = 'Person',  
@level1type = N'Table', @level1name = 'Address',   
@level2type = N'Column',@level2name = 'PostalCode';  
GO  

Г. Добавление расширенного свойства к файловой группе

В следующем примере расширенное свойство добавляется к файловой группе PRIMARY .

USE AdventureWorks2012;  
GO  
EXEC sys.sp_addextendedproperty   
@name = N'MS_DescriptionExample',   
@value = N'Primary filegroup for the AdventureWorks2012 sample database.',   
@level0type = N'FILEGROUP', @level0name = 'PRIMARY';  
GO  

Д. Добавление расширенного свойства к схеме

В следующем примере расширенное свойство добавляется к схеме HumanResources .

USE AdventureWorks2012;  
GO  
EXECUTE sys.sp_addextendedproperty   
@name = N'MS_DescriptionExample',  
@value = N'Contains objects related to employees and departments.',  
@level0type = N'SCHEMA',   
@level0name = 'HumanResources';  

Е. Добавление расширенного свойства к таблице

В следующем примере расширенное свойство добавляется к таблице Address , относящейся к схеме Person .

USE AdventureWorks2012;  
GO  
EXEC sys.sp_addextendedproperty   
@name = N'MS_DescriptionExample',   
@value = N'Street address information for customers, employees, and vendors.',   
@level0type = N'SCHEMA', @level0name = 'Person',  
@level1type = N'TABLE',  @level1name = 'Address';  
GO  

Ж. Добавление расширенного свойства к роли

В следующем примере создается роль приложения и добавляется расширенное свойство к роли.

USE AdventureWorks2012;   
GO  
CREATE APPLICATION ROLE Buyers  
WITH Password = '987G^bv876sPY)Y5m23';   
GO  
EXEC sys.sp_addextendedproperty   
@name = N'MS_Description',   
@value = N'Application Role for the Purchasing Department.',  
@level0type = N'USER',  
@level0name = 'Buyers';  

З. Добавление расширенного свойства к типу

В следующем примере расширенное свойство добавляется к типу.

USE AdventureWorks2012;   
GO  
EXEC sys.sp_addextendedproperty   
@name = N'MS_Description',   
@value = N'Data type (alias) to use for any column that represents an order number. For example a sales order number or purchase order number.',   
@level0type = N'SCHEMA',   
@level0name = N'dbo',   
@level1type = N'TYPE',   
@level1name = N'OrderNumber';  

И. Добавление расширенного свойства к пользователю

В следующем примере создается пользователь и добавляется расширенное свойство к пользователю.

USE AdventureWorks2012;   
GO  
CREATE USER CustomApp WITHOUT LOGIN ;   
GO  
EXEC sys.sp_addextendedproperty   
@name = N'MS_Description',   
@value = N'User for an application.',   
@level0type = N'USER',   
@level0name = N'CustomApp';  

См. также:

Хранимые процедуры ядра СУБД (Transact-SQL)
sys.fn_listextendedproperty (Transact-SQL)
sp_dropextendedproperty (Transact-SQL)
sp_updateextendedproperty (Transact-SQL)