COMMENT ON
{
TABLE object_name |
COLUMN table_name.column_name |
AGGREGATE agg_name (agg_type) |
CONSTRAINT constraint_name ON table_name |
DATABASE object_name |
DOMAIN object_name |
FUNCTION func_name (arg1_type, arg2_type, ...) |
INDEX object_name |
OPERATOR op (leftoperand_type, rightoperand_type) |
RULE rule_name ON table_name |
SCHEMA object_name |
SEQUENCE object_name |
TRIGGER trigger_name ON table_name |
TYPE object_name |
VIEW object_name
} IS 'text'COMMENTは、データベースオブジェクトに関するコメントを保存します。 コメントは、psqlの\dd、\d+、\l+ などで簡単に取り出すことができます。 obj_description() と col_description() という名前の、psql が使用している組み込み関数を使用するように構築することで、他のユーザインタフェースでコメントを取り出すことができます。
コメントを編集するには、同一オブジェクトに対して新しく COMMENT コマンドを発行してください。 各オブジェクトに保存されるコメント文字列は 1 つだけです。 コメントを削除するには、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 COLUMN my_table.my_column IS 'Employee ID number'; 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 OPERATOR ^ (text, text) IS 'Performs intersection of two texts'; COMMENT ON OPERATOR ^ (NONE, text) IS 'This is a prefix operator on text'; 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 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';