他のバージョンの文書10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

COMMENT

Name

COMMENT  --  オブジェクトのコメントを定義、または、変更します

Synopsis

COMMENT ON
[
  [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] object_name |
  COLUMN table_name.column_name |
  AGGREGATE agg_name (agg_type) |
  FUNCTION func_name (arg1, arg2, ...) |
  OPERATOR op (leftoperand_type rightoperand_type) |
  TRIGGER trigger_name ON table_name
] IS 'text'

入力

object_name, table_name,column_name, agg_name, func_name, op, trigger_name

コメントを付けるオブジェクトの名前です。

text

追加するコメントです。

出力

COMMENT

テーブルのコメント付けが成功した場合に返されるメッセージです。

説明

COMMENTは、データベースオブジェクトに関するコメントを保存します。コメントは、 psql\dd\d+\l+ などで簡単に取りだすことができます。obj_description()col_description() という名前の、psql が使用している組み込み関数を使用するように構築することで、他のユーザインタフェースでコメントを取り出すことができます。

コメントを編集するには、同一オブジェクトに対して新しく COMMENT コマンドを発行します。各オブジェクトに保存されるコメント文字列は 1 つだけです。コメントを削除するには、 NULL をテキスト文字列の部分に書きます。オブジェクトが削除された時、コメントは自動的に削除されます。

現在、コメントにセキュリティ機構が存在しないことには注意しなければなりません。データベースに接続したユーザは誰でも、そのデータベース内のオブジェクトのコメントを参照することができます(しかし、スーパーユーザのみが所有していないオブジェクトに関するコメントを変更することができます)。そのため、セキュリティ的に致命的な情報をコメントに記載してはいけません。

使用方法

mytable テーブルにコメントを付けます。

COMMENT ON mytable IS 'This is my table.';

いくつか他の例を示します。

COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee id';
COMMENT ON RULE my_rule IS 'Logs UPDATES of employee records';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
COMMENT ON TABLE my_table IS 'Employee Information';
COMMENT ON TYPE my_type IS 'Complex Number support';
COMMENT ON VIEW my_view IS 'View of departmental costs';
COMMENT ON COLUMN my_table.my_field IS 'Employee ID number';
COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two text';
COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for R.I.';

互換性

SQL92

SQL92 には COMMENT はありません。