sp_updateextendedproperty(Transact-SQL)

  • 아티클

적용 대상:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

기존 확장 속성의 값을 업데이트.

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 기본값NULL인 sql_variant. 값의 크기는 7,500바이트를 초과할 수 없습니다.

[ @level0type = ] 'level0type'

사용자 또는 사용자 정의 형식입니다. @level0type 기본값NULL인 varchar(128)입니다. 잘못된 입력:

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

Important

USER및 TYPE 수준 0 형식은 이후 버전의 SQL Server에서 제거됩니다. 새 개발 작업에서는 이 기능을 사용하지 말고, 현재 이 기능을 사용하는 애플리케이션은 수정하세요. 대신 수준 0 형식USER으로 사용합니다SCHEMA. 의 경우 TYPE수준 0 형식 및 TYPE 수준 1 형식으로 사용합니다 SCHEMA.

[ @level0name = ] N'level0name'

지정된 수준 0 개체 형식의 이름입니다. @level0name sysname이며 기본값은 .입니다NULL.

[ @level1type = ] 'level1type'

수준 1 개체의 형식입니다. @level1type 기본값NULL인 varchar(128)입니다. 잘못된 입력:

  • 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 기본값NULL인 varchar(128)입니다. 잘못된 입력:

  • 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 권한이 있는 개체로 업데이트할 수 있습니다.

예제

A. 열의 확장 속성 업데이트

다음 예제에서는 테이블T1의 열 ID 에서 속성 Caption 값을 업데이트합니다.

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

관련 콘텐츠