[DB_MSSQL] sp_addextendedproperty 주석 (테이블/컬럼)

sp_addextendedproperty를 이용하여 테이블 및 컬럼에 주석을 달아보자

특정 테이블 및 컬럼에 대한 설명이 따로 적혀 있지 않으면, 해당 정보에 대해 알기 어렵다.

테이블 및 컬럼에 대해 설명을 달아보자

주석 추가/수정

-- 주석 추가 (테이블)
EXEC sp_addextendedproperty 'MS_Description', '테이블설명', 'user', dbo, 'table', 테이블명
 
-- 주석 추가 (컬럼)
EXEC sp_addextendedproperty 'MS_Description',' 컬럼설명', 'user', dbo, 'table', 테이블명, 'column', 컬럼명
 
-- 주석 수정 (테이블)
EXEC sp_updateextendedproperty 'MS_Description', '테이블설명', 'user', dbo, 'table', 테이블명
 
-- 주석 수정 (컬럼)
EXEC sp_updateextendedproperty 'MS_Description', '컬럼설명', 'user', dbo, 'table', 테이블명, 'column', 컬럼명

주석 조회

-- 테이블 주석 조회
SELECT
    NAME
    , (SELECT TOP 1 VALUE FROM SYS.EXTENDED_PROPERTIES WHERE MAJOR_ID = A.ID AND MINOR_ID = 0 ) COMMENT
    , crdate
FROM SYSOBJECTS A
WHERE RTRIM(A.XTYPE) = 'U' AND NAME = '테이블명'

-- 컬럼 주석 조회
SELECT
    NAME
    , (SELECT TOP 1 VALUE FROM SYS.EXTENDED_PROPERTIES WHERE MAJOR_ID = A.ID AND MINOR_ID = 0 ) COMMENT
    , OBJECT_NAME(ID) TABLENAME
FROM SYSCOLUMNS A
WHERE NAME = '컬럼명'