| PostgreSQL 8.3.3문서 | ||||
|---|---|---|---|---|
| Prev | Fast Backward | Fast Forward | Next | |
COMMENT ON
{
TABLE
object_name
|
COLUMN
table_name
.
column_name
|
AGGREGATE
agg_name
(
agg_type
[, ...] ) |
CAST (
sourcetype
AS
targettype
) |
CONSTRAINT
constraint_name
ON
table_name
|
CONVERSION
object_name
|
DATABASE
object_name
|
DOMAIN
object_name
|
FUNCTION
func_name
( [ [
argmode
] [
argname
]
argtype
[, ...] ] ) |
INDEX
object_name
|
LARGE OBJECT
large_object_oid
|
OPERATOR
op
(
leftoperand_type
,
rightoperand_type
) |
OPERATOR CLASS
object_name
USING
index_method
|
[ PROCEDURAL ] LANGUAGE
object_name
|
ROLE
object_name
|
RULE
rule_name
ON
table_name
|
SCHEMA
object_name
|
SEQUENCE
object_name
|
TABLESPACE
object_name
|
TRIGGER
trigger_name
ON
table_name
|
TYPE
object_name
|
VIEW
object_name
} IS
'text'
COMMENT는, 데이터베이스 객체에 관한 코멘트를 저장합니다.
코멘트를 편집하려면, 동일 객체에 대해서 새로운 COMMENT명령을 발행해 주세요. 각 객체에 보존할 수 있는 코멘트 캐릭터 라인은 1개 뿐입니다. 코멘트를 삭제하려면, 텍스트 문자열에 NULL를 기술해 주세요. 객체가 삭제되었을 때, 코멘트는 자동적으로 삭제됩니다.
코멘트는, psql의 \d계의 명령으로 표시할 수 있습니다.
obj_description(), col_description(), shobj_description라는 이름의, psql가
사용하는 내장 함수를 구축하는 것으로, 다른 사용자 인터페이스를 사용해 코멘트를 꺼낼 수 있게 됩니다
(Table 9-44를 참조해 주세요).
코멘트를 부가하는 객체의 이름입니다. 테이블, 집계, 도메인, 함수, 인덱스, 연산자, 연산자 클래스, 연산자 클래스, 시퀀스, 데이터형, 뷰는 스키마 수식할 수 있습니다.
집계 함수가 연산하는 입력 데이터형입니다. 인자를 가지지 않는 집계 함수를 참조하는 경우는, 입력 데이터형의 리스트에 *를 지정해 주세요.
캐스트의 소스데이터형의 이름입니다.
캐스트의 대상 데이터형의 이름입니다.
함수 인자의 모드로, IN, OUT, INOUT의 하나입니다. 생략시, 기본값은 IN입니다. 함수를 식별하려면 입력 인자만이 필요하므로, COMMENT ON FUNCTION가 실제로는 OUT인자를 무시하는 것에 주의해 주세요. 따라서, IN와 INOUT인자를 열거하는 것으로 충분합니다.
함수 인자의 이름입니다. 함수의 식별에는 인자 데이터형만이 필요하므로, COMMENT ON FUNCTION가 실제로는 인자의 이름을 무시하는 것에 주의해 주세요.
만약 있으면, 함수 인자의 데이터형(복수가능, 스키마 수식도 가능)입니다.
큰 객체의 OID입니다.
이것은 노이즈 워드입니다.
새로운 코멘트입니다. 문자열 문자상수로서 기술합니다. 코멘트를 삭제하는 경우는 NULL를 기술합니다.
현재, 코멘트에는 보안 구조는 존재하지 않습니다. 데이터베이스에 접속한 사용자는 누구라도, 그 데이터베이스 내의 객체의 코멘트를 참조할 수가 있습니다 (다만, 소유하고 있지 않는 객체에 관한 코멘트를 변경할 수 있는 것은 슈퍼 유저만입니다). 데이터베이스, 역할, 테이블 공간등의 공유 객체에 대한 코멘트는 포괄적으로 저장되어, 임의의 데이터베이스에 접속한 임의의 사용자가 공유 객체에 대한 코멘트를 모두 볼 수 있습니다. 그 때문에, 코멘트에는 보안상 중대한 정보를 기재 해서는 안됩니다.
mytable테이블에 코멘트를 붙입니다.
COMMENT ON TABLE mytable IS 'This is my table.';
방금전의 코멘트를 삭제합니다.
COMMENT ON TABLE mytable IS NULL;
그 외의 예
COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance'; COMMENT ON CAST (text AS int4) IS 'Allow casts from text to int4'; COMMENT ON COLUMN my_table.my_column IS 'Employee ID number'; COMMENT ON CONVERSION my_conv IS 'Conversion to UTF8'; COMMENT ON DATABASE my_database IS 'Development Database'; COMMENT ON DOMAIN my_domain IS 'Email Address Domain'; COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral'; COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee ID'; COMMENT ON LANGUAGE plpython IS 'Python support for stored procedures'; COMMENT ON LARGE OBJECT 346344 IS 'Planning document'; COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two texts'; COMMENT ON OPERATOR - (NONE, text) IS 'This is a prefix operator on text'; COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees'; COMMENT ON ROLE my_role IS 'Administration group for finance tables'; COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records'; COMMENT ON SCHEMA my_schema IS 'Departmental data'; COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys'; COMMENT ON TABLE my_schema.my_table IS 'Employee Information'; COMMENT ON TABLESPACE my_tablespace IS 'Tablespace for indexes'; COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for RI'; COMMENT ON TYPE complex IS 'Complex number data type'; COMMENT ON VIEW my_view IS 'View of departmental costs';