他のバージョンの文書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 ( [ [ argmode ] [ argname ] argtype [, ...] ] ) |
  INDEX object_name |
  LARGE OBJECT large_object_oid |
  OPERATOR op (leftoperand_type, rightoperand_type) |
  OPERATOR CLASS object_name USING index_method |
  OPERATOR FAMILY object_name USING index_method |
  [ PROCEDURAL ] LANGUAGE object_name |
  RULE rule_name ON table_name |
  ROLE object_name |
  SCHEMA object_name |
  SEQUENCE object_name |
  TABLESPACE object_name |
  TEXT SEARCH CONFIGURATION object_name |
  TEXT SEARCH DICTIONARY object_name |
  TEXT SEARCH PARSER object_name |
  TEXT SEARCH TEMPLATE 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が使用する組み込み関数を使うように構築することで、他のユーザインタフェースを使ってコメントを取り出せるようになります (表9-48を参照してください)。

パラメータ

object_name
table_name.column_name
agg_name
constraint_name
func_name
op
rule_name
trigger_name

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

agg_type

集約関数が演算する入力データ型です。 引数を持たない集約関数を参照する場合は、入力データ型のリストに*を指定してください。

sourcetype

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

targettype

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

argmode

関数の引数のモードで、INOUTINOUTのいずれかです。 省略時のデフォルトはINです。 関数を識別するには入力引数のみが必要ですので、COMMENT ON FUNCTIONが実際にはOUT引数を無視することに注意してください。 したがって、ININOUT引数を列挙することで十分です。

argname

関数の引数の名前です。 関数の識別には引数データ型のみが必要ですので、COMMENT ON FUNCTIONが実際には引数の名前を無視することに注意してください。

argtype

もしあれば、関数の引数のデータ型(複数可、スキーマ修飾も可)です。

large_object_oid

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

PROCEDURAL

これはノイズワードです。

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 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 OPERATOR FAMILY integer_ops USING btree IS 'all 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 TEXT SEARCH CONFIGURATION my_config IS 'Special word filtering';
COMMENT ON TEXT SEARCH DICTIONARY swedish IS 'Snowball stemmer for swedish language';
COMMENT ON TEXT SEARCH PARSER my_parser IS 'Splits text into words';
COMMENT ON TEXT SEARCH TEMPLATE snowball IS 'Snowball stemmer';
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はありません。