데이터베이스 객체에 대한 설명을 생성하거나 변경합니다.
구문
COMMENT ON { TABLE object_name | COLUMN object_name.column_name | CONSTRAINT constraint_name ON table_name | DATABASE object_name | VIEW object_name } IS 'text' | NULL
파라미터
- 객체 이름
-
설명 대상이 되는 데이터베이스 객체의 이름입니다. 다음 객체에 설명을 추가할 수 있습니다.
-
TABLE
-
COLUMN(column_name도 취함).
-
CONSTRAINT(constraint_name 및 table_name도 취함).
-
데이터베이스
-
VIEW
-
스키마
-
- IS 'text' | NULL
-
지정된 객체에 대해 추가하거나 바꿀 설명 텍스트입니다. text 문자열은 TEXT 데이터 형식입니다. 설명은 작은따옴표로 묶으세요. 설명 텍스트를 제거하려면 값을 NULL로 설정합니다.
- column_name
-
설명 대상이 되는 열의 이름입니다. COLUMN의 파라미터입니다.
object_name에 지정된 테이블을 따릅니다. - constraint_name
-
설명 대상이 되는 제약 조건의 이름입니다. CONSTRAINT의 파라미터입니다.
- table_name
-
제약 조건을 포함한 테이블의 이름입니다. CONSTRAINT의 파라미터입니다.
사용 노트
슈퍼유저 또는 데이터베이스 객체의 소유자만 설명을 추가하거나 업데이트할 수 있습니다.
데이터베이스에 대한 설명은 현재 데이터베이스에만 적용될 수 있습니다. 다른 데이터베이스에 대해 설명하려는 경우 경고 메시지가 표시됩니다. 존재하지 않는 데이터베이스에 대한 설명을 하려고 할 때도 같은 경고가 표시됩니다.
외부 테이블, 외부 열 및 후기 바인딩 뷰의 열에 대한 댓글은 지원되지 않습니다.
예시
다음 예에서는 SALES 테이블에 새 열을 추가합니다.
COMMENT ON TABLE sales IS 'This table stores tickets sales data';다음 예에서는 SALES 테이블에 설명을 표시합니다.
select obj_description('public.sales'::regclass);
obj_description
-------------------------------------
This table stores tickets sales data
다음 예에서는 SALES 테이블에서 설명을 제거합니다.
COMMENT ON TABLE sales IS NULL;다음 예에서는 SALES 테이블의 EVENTID 열에 설명을 추가합니다.
COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';다음 예에서는 SALES 테이블의 EVENTID 열(열 번호 5)에 설명을 표시합니다.
select col_description( 'public.sales'::regclass, 5::integer );
col_description
-----------------------------------------
Foreign-key reference to the EVENT table.
다음 예에서는 설명문을 EVENT 테이블에 추가합니다.
comment on table event is 'Contains listings of individual events.';설명을 보려면 PG_DESCRIPTION 시스템 테이블을 쿼리합니다. 다음 예에서는 EVENT 테이블에 대한 설명을 반환합니다.
select * from pg_catalog.pg_description
where objoid =
(select oid from pg_class where relname = 'event'
and relnamespace =
(select oid from pg_catalog.pg_namespace where nspname = 'public') );
objoid | classoid | objsubid | description
-------+----------+----------+----------------------------------------
116658 | 1259 | 0 | Contains listings of individual events.