[Oracle] 주석 설정 방법, COMMENT ON COLUMN

오라클에서 컬럼에 주석(comment)을 설정하는 방법에 대해 알아보도록 하겠습니다. 정확히는 설정하는 방법보다는, 이미 컬럼에 설정된 코멘트를 추출하는 방법을 안내해드리려고 합니다. 데이터베이스를 각각 납품할 때에 가끔 한글로 된 주석이 글자가 깨지거나, 누락이 되는 경우가 있습니다. 이에 대한 보완책으로 간단히 작성해 본 것이랍니다~

주석을 추가하는 것은 테이블과 같은 객체의 구조를 더 잘 이해할 수 있게 도와주는 중요한 역할을 합니다. 컬럼을 추가할 때마다 코멘트도 동시에 추가하는 습관은, 추후 문서화에 적절한 도움을 많이 줄 것입니다. 왜냐 하면, 코멘트는 데이터베이스를 생성한 개발자뿐만 아니라, 이후에 데이터베이스를 분석하는 사용자에게 이 테이블과 컬럼의 용도를 직관적으로 알 수 있도록 지원하기 때문입니다.

다음의 SQL 쿼리는 주석을 설정(추출)하는 데 사용할 수 있습니다. 추출한 명령어는 해당 테이블의 각 컬럼에 대한 코멘트를 추가하는 데 사용할 수 있습니다! 참고 용도로 사용해 주세요. 가공하여 다양한 용도로 사용할 수도 있을 것입니다.

SELECT    'COMMENT ON COLUMN '
       || OWNER
       || '.'
       || TABLE_NAME
       || '.'
       || COLUMN_NAME
       || ' IS '''
       || COMMENTS
       || '''; '
          SRC,
       TA.*
  FROM ALL_COL_COMMENTS TA
 WHERE 0 = 0 
   AND OWNER = 'USER_NAME';

다음은 위의 쿼리 결과 중 일부를 출력해 본 결과입니다.

COMMENT ON COLUMN USER_NAME.TABLE_NAME.COLUMN_NAME IS 'COMMENT'; USER_NAME TABLE_NAME COLUMN_NAME COMMENT

이 쿼리는 ALL_COL_COMMENTS 뷰를 사용하여 데이터 딕셔너리에서 컬럼에 대한 코멘트를 가져옵니다. OWNER와 TABLE_NAME을 특정 테이블에 맞게 바꾸는 등 조건을 적절히 추가하고 실행하면 해당 테이블의 각 컬럼에 대한 주석을 확인할 수 있습니다.