メニュー
Amazon Redshift
データベース開発者ガイド (API Version 2012-12-01)

COMMENT

データベースオブジェクトに関するコメントを作成するか変更します。

構文

Copy
COMMENT ON { TABLE object_name | COLUMN object_name.column_name | CONSTRAINT constraint_name ON table_name | DATABASE object_name | VIEW object_name } IS 'text'

パラメーター

object_name

コメント対象のデータベースオブジェクトの名前。コメントは次のオブジェクトに追加できます。

  • TABLE

  • COLUMN (column_name も取ります)

  • CONSTRAINT (constraint_nametable_name も取ります)

  • DATABASE

  • VIEW

IS 'text''

指定したオブジェクトに適用するコメントのテキスト。コメントは一重引用符で囲みます。

column_name

コメント対象の列の名前。COLUMN のパラメーター。object_name で指定するテーブルの後に指定します。

constraint_name

コメント対象の制約の名前。CONSTRAINT のパラメーター。

table_name

制約を含むテーブルの名前。CONSTRAINT のパラメーター。

arg1_type, arg2_type, ...

関数の引数のデータ型。FUNCTION のパラメーター。

使用に関する注意事項

データベースに関するコメントは現在のデータベースにのみ適用できます。異なるデータベースにコメントしようとすると、警告メッセージが表示されます。存在しないデータベースに関するコメントに対しても、同じ警告が表示されます。

SQL コマンドを使用して直接コメントを取得することはできません。コメントは、\d コマンドファミリーを使用する PostresSQL psql ツールを使用して表示することもできます。

次の例では、説明的なコメントを EVENT テーブルに追加します。

Copy
comment on table event is 'Contains listings of individual events.';

次の例は、psql \dd コマンドを使用してコメントを表示します。Amazon Redshift は、psql を直接サポートしていません。PostgreSQL psql クライアントから psql コマンドを実行する必要があります。

Copy
\dd event Object descriptions schema | name | object | description --------+-------+--------+----------------------------------------- public | event | table | Contains listings of individual events. (1 row)