[Oracle] Table / Column Comment - 코멘트, 설명 달기

Comment

-- Table Comment 추가 
comment on table [Table Name] is '[Table Comment]';

-- Column Comment 추가
comment on column [Table Name].[Column Name] is '[Column Comment]';

 

오라클의 테이블과 컬럼에 대한 코멘트를 다는 방법은 매우 간단하다.

테이블, 컬럼은 여러 사람이 같이 사용하는 공공재라고 볼 수 있는데, 이런 테이블과 컬럼에 코멘트를 달아 자세한 설명을 추가하는 것을 기본으로 한다.

 

테이블이나 컬럼 명칭은 표준화로 명확하지만 심플하게 만들되, 코멘트는 최대한 자세히 추가한다고 생각하자.

 

Table Comment 

테이블에 대한 코멘트 추가, 변경, 삭제는 하나의 명령어로 모두 해결이 된다.

-- Table Comment 추가 
comment on table [Table Name] is '[Table Comment]';

-- Table Comment 삭제
comment on table [Table Name] is '';

-- Table Comment 변경
comment on table [Table Name] is '[NEW Table Comment]';

테이블에 코멘트를 추가하기 위해서는 위와 같은 명령어를 통해 추가 한다.

코멘트를 삭제하기 위해서는 빈 값을 입력을 하여 삭제를 한다.

변경의 경우 다시 한번 추가와 같은 명령어를 통해 새로운 코멘트를 추가한다.

반응형

Column Comment 

컬럼에 대한 코멘트 추가, 변경, 삭제 또한 테이블 코멘트 명령어와 같이 하나의 명령어로 모두 해결이 된다.

-- Column Comment 추가 
comment on column [Table Name].[Column Name] is '[Column Comment]';

-- Column Comment 삭제
comment on column [Table Name].[Column Name] is '';

-- Column Comment 변경
comment on column [Table Name].[Column Name] is '[NEW Column Comment]';

컬럼에 코멘트를 추가하기 위해서는 테이블명.컬럼명을 지정하여 해당 컬럼에 코멘트를 추가한다.

컬럼 코멘트를 삭제는 마찬가지로 테이블명.컬럼명에 빈 코멘트를 업데이트하여 삭제한다.

컬럼 코멘트 변경할 경우 새로운 코멘트로 새롭게 추가한다.

Comment 조회

테이블과 컬럼에 대한 코멘트 조회는 각각 코멘트 정의가 모여있는 시스템 테이블에서 확인이 가능하다.

-- Table Comment 조회
select * from USER_TAB_COMMENTS;

-- Column Comment 조회
select * from USER_COL_COMMENTS;

 

특정 테이블의 코멘트를 조회하기 위해 아래와 같은 명령어를 실행하면 다음과 같은 값을 얻을 수 있다.

select * 
  from USER_TAB_COMMENTS 
 where table_name = 'TB_TEST_CMT';

 

특정 테이블 컬럼들에 대한 코멘트를 조회하기 위해서는 아래와 같은 명령어를 실행하여 결과를 얻는다.

select * 
  from USER_COL_COMMENTS 
 where table_name = 'TB_TEST_CMT';

특정 테이블이 아닌 특정 컬럼명으로 조회하여, 표준화가 되어 있는 컬럼들에 대해서 동일한 코멘트가 달려 있는지도 확인 할 수 있다.