Поделиться через

sp_updateextendedproperty (Transact-SQL)

  • Статья

Область применения: SQL Server База данных SQL Azure Управляемый экземпляр SQL Azure

Обновляет значение существующего расширенного свойства.

Соглашения о синтаксисе Transact-SQL

Синтаксис

sp_updateextendedproperty
    [ @name = ] N'name'
    [ , [ @value = ] value ]
    [ , [ @level0type = ] 'level0type' ]
    [ , [ @level0name = ] N'level0name' ]
    [ , [ @level1type = ] 'level1type' ]
    [ , [ @level1name = ] N'level1name' ]
    [ , [ @level2type = ] 'level2type' ]
    [ , [ @level2name = ] N'level2name' ]
[ ; ]

Аргументы

[ @name = ] N'name'

Имя обновляемого свойства. @name — sysname без значения по умолчанию.

[ @value = ] value

Значение, связанное с свойством. @value sql_variant с значением по умолчаниюNULL. Размер значения не может превышать 7500 байт.

[ @level0type = ] 'level0type'

Определяемый пользователем тип. @level0type — varchar(128) с значением по умолчаниюNULL. Допустимые входные значения:

  • ASSEMBLY
  • CONTRACT
  • EVENT NOTIFICATION
  • FILEGROUP
  • MESSAGE TYPE
  • PARTITION FUNCTION
  • PARTITION SCHEME
  • PLAN GUIDE
  • REMOTE SERVICE BINDING
  • ROUTE
  • SCHEMA
  • SERVICE
  • USER
  • TRIGGER
  • TYPE
  • 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. Допустимые входные значения:

  • ASSEMBLY
  • CONTRACT
  • EVENT NOTIFICATION
  • FILEGROUP
  • MESSAGE TYPE
  • PARTITION FUNCTION
  • PARTITION SCHEME
  • PLAN GUIDE
  • REMOTE SERVICE BINDING
  • ROUTE
  • SCHEMA
  • SERVICE
  • USER
  • TRIGGER
  • TYPE
  • NULL

[ @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). Уровень 0 является высшим уровнем и определяется как «объекты в области базы данных». Объекты уровня 1 содержатся в схеме и в пользовательской области, а объекты уровня 2 содержатся в объектах уровня 1. Расширенные свойства могут быть определены для объектов на любом из этих уровней. Ссылки на объект определенного уровня должны быть уточнены именами объектов более высокого уровня, в которых они содержатся или которым они принадлежат.

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

Разрешения

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

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

Примеры

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

В следующем примере обновляется значение свойства Caption столбца ID в таблице T1.

USE AdventureWorks2022;
GO

CREATE TABLE T1 (id INT, name CHAR(20));
GO

EXEC sp_addextendedproperty @name = N'Caption',
    @value = N'Employee ID',
    @level0type = 'SCHEMA',
    @level0name = N'dbo',
    @level1type = 'TABLE',
    @level1name = N'T1',
    @level2type = 'COLUMN',
    @level2name = N'id';
GO

--Update the extended property.
EXEC sp_updateextendedproperty @name = N'Caption',
    @value = 'Employee ID must be unique.',
    @level0type = 'SCHEMA',
    @level0name = N'dbo',
    @level1type = 'TABLE',
    @level1name = N'T1',
    @level2type = 'COLUMN',
    @level2name = N'id';
GO

B. Обновление расширенного свойства в базе данных

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

USE AdventureWorks2022;
GO

EXEC sp_addextendedproperty @name = N'NewCaption',
    @value = 'AdventureWorks Sample OLTP Database';
GO

USE AdventureWorks2022;
GO

EXEC sp_updateextendedproperty @name = N'NewCaption',
    @value = 'AdventureWorks Sample Database';
GO

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