[ORACLE] USER_TAB_COMMENTS 뷰로 테이블 주석 관리 및 문서화 자동화하기

[ORACLE] USER_TAB_COMMENTS

1. USER_TAB_COMMENTS란?

USER_TAB_COMMENTS는 Oracle 데이터베이스에서 사용자 스키마 내 테이블 및 뷰에 대한 주석(Comment)을 저장하는 데이터 딕셔너리 뷰입니다. 이 뷰는 COMMENT ON TABLE 구문으로 작성된 주석을 저장하며, **데이터 모델링, 유지보수, 자동 문서화 시스템**에서 핵심적인 역할을 수행합니다.

2. COMMENT ON TABLE 구문 예시

COMMENT ON TABLE employees IS '사원 기본 정보 테이블';
COMMENT ON TABLE orders IS '주문 내역 기록용 테이블';
      

위 명령을 실행하면 해당 주석 정보가 USER_TAB_COMMENTS에 저장됩니다.

3. 주요 컬럼 설명

컬럼명	설명
TABLE_NAME	주석이 적용된 테이블 또는 뷰의 이름
TABLE_TYPE	객체 유형 (TABLE 또는 VIEW)
COMMENTS	테이블 또는 뷰에 대한 설명 텍스트

4. 실전 활용 예제

-- 모든 테이블과 주석 목록 조회
SELECT TABLE_NAME, COMMENTS
FROM USER_TAB_COMMENTS
ORDER BY TABLE_NAME;

-- 특정 키워드를 포함한 주석 검색
SELECT TABLE_NAME, COMMENTS
FROM USER_TAB_COMMENTS
WHERE COMMENTS LIKE '%이력%';
      

이 정보는 ERD 도구, 데이터 사전 문서 자동화 등에 활용됩니다.

5. 관련 뷰 비교

뷰 이름	설명	주요 용도
USER_TAB_COMMENTS	테이블/뷰 주석 정보	데이터 객체 단위 설명
USER_COL_COMMENTS	컬럼 주석 정보	테이블 내부 컬럼 설명
DBA_TAB_COMMENTS	모든 사용자 객체의 주석	DBA 전용 문서화

6. 고급 활용 전략

• 자동 문서 생성: Python, Java, PL/SQL 등으로 주석을 추출하여 문서화
• 주석 일관성 감사: 주석 누락 객체 자동 감지
• ERD 연동: Oracle SQL Developer, DataGrip 등과 연계하여 주석 표시

7. 결론

USER_TAB_COMMENTS는 데이터베이스 설계, 문서화, 유지보수, 데이터 거버넌스에 있어 작지만 매우 중요한 역할을 하는 뷰입니다. 주석 관리 습관을 잘 갖춘 시스템은 유지보수 효율성과 협업 품질이 크게 향상됩니다.

참고 자료

• Oracle® Database SQL Language Reference 21c
• Oracle® Database Data Dictionary Reference
• Oracle Help Center: https://docs.oracle.com/en/database/