sp_updateextendedproperty (Transact-SQL)
Updates the value of an existing extended property.
sp_updateextendedproperty
[ @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' }
]
]
]
]
For the purpose of specifying extended properties, the objects in a SQL Server database are classified into three levels (0, 1, and 2). Level 0 is the highest level and is defined as objects contained at the database scope. 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 names of the higher level objects that own or contain them.
Given a valid property_name and value, if all object types and names are null, the property updated belongs to the current database.
Members of the db_owner and db_ddladmin fixed database roles may update the extended properties of any object with the following exception: db_ddladmin may not add properties to the database itself, or to users or roles.
Users may update extended properties to objects they own, or on which they have ALTER or CONTROL permissions.
A. Updating an extended property on a column
The following example updates the value of property Caption on column ID in table T1.
USE AdventureWorks2012;
GO
CREATE TABLE T1 (id int , name char (20));
GO
EXEC sp_addextendedproperty
@name = N'Caption'
,@value = N'Employee ID'
,@level0type = N'Schema', @level0name = dbo
,@level1type = N'Table', @level1name = T1
,@level2type = N'Column', @level2name = id;
GO
--Update the extended property.
EXEC sp_updateextendedproperty
@name = N'Caption'
,@value = 'Employee ID must be unique.'
,@level0type = N'Schema', @level0name = dbo
,@level1type = N'Table', @level1name = T1
,@level2type = N'Column', @level2name = id;
GO
B. Updating an extended property on a database
The following example first creates an extended property on the AdventureWorks2012 sample database and then updates the value of that property.
USE AdventureWorks2012; GO EXEC sp_addextendedproperty @name = N'NewCaption', @value = 'AdventureWorks2012 Sample OLTP Database'; GO USE AdventureWorks2012; GO EXEC sp_updateextendedproperty @name = N'NewCaption', @value = 'AdventureWorks2012 Sample Database'; GO
