[MSSQL]테이블 컬럼 코멘트 추가

MSSQL에서 테이블과 컬럼의 코멘트는 데이터베이스 스키마 문서화에 매우 중요한 역할을 합니다.

테이블과 컬럼에 코멘트를 추가하면, 해당 테이블과 컬럼이 어떤 정보를 담고 있고,

그 정보가 어떤 용도로 사용되는지에 대한 설명을 제공할 수 있습니다.

코멘트는 다른 개발자나 데이터베이스 관리자가 데이터베이스를 이해하고 유지보수하는 데 매우 유용합니다.

MSSQL에서 테이블과 컬럼의 코멘트를 추가하는 방법은 

 

1.테이블 코멘트 추가

반응형

EXEC sp_addextendedproperty 
   @name = N'MS_Description', 
   @value = N'테이블 설명',
   @level0type = N'SCHEMA',
   @level0name = N'dbo',
   @level1type = N'TABLE',
   @level1name = N'테이블 이름';

 

 

 

 

2.컬럼 코멘트 추가

 

EXEC sp_addextendedproperty 
   @name = N'MS_Description', 
   @value = N'컬럼 설명',
   @level0type = N'SCHEMA',
   @level0name = N'dbo',
   @level1type = N'TABLE',
   @level1name = N'테이블 이름',
   @level2type = N'COLUMN',
   @level2name = N'컬럼 이름';

 

다음으로는 추가된 코멘트 정보 조회를 하는 방법입니다.

 

728x90

 

1.테이블 코멘트 조회

 

SELECT 
    obj.name AS 'Table Name', 
    ep.value AS 'Table Description'
FROM 
    sys.objects obj
LEFT JOIN 
    sys.extended_properties ep ON 
        ep.major_id = obj.object_id AND 
        ep.minor_id = 0 AND 
        ep.class = 1 AND 
        ep.name = 'MS_Description'
WHERE 
    obj.type = 'U' AND 
    obj.name = '테이블 이름';

 

 

 

2.컬럼 코멘트 조회 

 

 

SELECT 
    obj.name AS 'Table Name', 
    col.name AS 'Column Name', 
    ep.value AS 'Column Description'
FROM 
    sys.objects obj
INNER JOIN 
    sys.columns col ON 
        col.object_id = obj.object_id
LEFT JOIN 
    sys.extended_properties ep ON 
        ep.major_id = obj.object_id AND 
        ep.minor_id = col.column_id AND 
        ep.class = 1 AND 
        ep.name = 'MS_Description'
WHERE 
    obj.type = 'U' AND 
    obj.name = '테이블 이름';