MSSQL 테이블 코멘트(Description) 추가/삭제/조회

 

 

테이블 Description을 달아두면 다른 사람들이 해당 시스템을 분석 또는 파악할 때 아주 편합니다. 

따라서 개발이나 유지/보수를 할때 테이블 및 컬럼의 설명을 달아주는 습관을 가져 봅시다.

코멘트 즉 Description 을 추가, 삭제, 조회하는 쿼리입니다.

 

설명 및 예제

 

테이블 코멘트 추가

EXEC sp_addextendedproperty 'MS_Description', '테이블설명', 'USER', dbo, 'TABLE', 테이블이름

EXEC sp_addextendedproperty 'MS_Description', '임시테이블', 'USER', dbo, 'TABLE', Temp_Table

 

테이블 코멘트 삭제

EXEC sp_dropextendedproperty 'MS_Description', 'SCHEMA', dbo, 'TABLE', 테이블이름, DEFAULT, DEFAULT

EXEC sp_dropextendedproperty 'MS_Description', 'SCHEMA', dbo, 'TABLE', Temp_Table, DEFAULT, DEFAULT

 

테이블 코멘트 조회

SELECT OBJTYPE         , OBJNAME         , NAME         , VALUE FROM ::FN_LISTEXTENDEDPROPERTY (NULL, 'SCHEMA', 'dbo', 'TABLE', '테이블이름', DEFAULT, DEFAULT)

SELECT OBJTYPE          , OBJNAME         , NAME          , VALUE AS '설명(Description)' FROM ::FN_LISTEXTENDEDPROPERTY (NULL, 'SCHEMA', 'dbo', 'TABLE', 'Temp_Table', DEFAULT, DEFAULT)

  위 테이블 조회 쿼리를 실행했을 경우 결과입니다.

조회 객체는 TABLE이고, 테이블 명이 조회됩니다. 그리고 Description의 내용은 '임시테이블' 로 나타나는 것을 확인할 수 있습니다. 

MS-SQL 테이블 Description 추가, 삭제, 조회 예제였습니다.