他のバージョンの文書 11 | 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

名前

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

概要

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 (arg1_type, arg2_type, ...) |
  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 |
  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は、データベースオブジェクトに関するコメントを保存します。

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

コメントは、psqlのコマンド\dd\d+\l+で簡単に取り出すことができます。 obj_description()col_description()という名前の、psqlが使用している組込み関数を使用するように構築することで、他のユーザインタフェースでコメントを取り出すことができます。 (表9-43を参照してください。)

パラメータ

object_name
table_name.column_name
agg_name
constraint_name
func_name
op
rule_name
trigger_name

コメントを付けるオブジェクトの名前です。 テーブル、集約、ドメイン、関数、インデックス、演算子、演算子クラス、シーケンス、データ型、およびビューの名前は、スキーマ修飾することができます。

agg_type

集約関数の引数データ型です。もし、関数が任意のデータ型を受け付ける場合は*です。

large_object_oid

ラージオブジェクトのOIDです。

PROCEDURAL

この単語はノイズです。

sourcetype

キャストの変換元データ型の名前です。

targettype

キャストの変換先のデータ型の名前です。

text

文字列リテラルとして記述される、追加するコメントです。 コメントを削除する場合は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 Unicode';
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 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';

互換性

標準SQLにはCOMMENTはありません。