COMMENT - Amazon Redshift
構文パラメータ使用に関する注意事項例

COMMENT

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

構文

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

パラメータ

object_name

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

  • TABLE

  • COLUMN (column_name も取ります)

  • CONSTRAINT (constraint_name と table_name も取ります)

  • DATABASE

  • VIEW

  • SCHEMA

IS 'text' | NULL

指定したオブジェクトに追加または置換するコメントテキスト。テキスト文字列のデータ型は TEXT です。コメントは一重引用符で囲みます。コメントテキストを削除するには、値を NULL に設定します。

column_name

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

constraint_name

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

table_name

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

使用に関する注意事項

コメントを追加または更新するには、スーパーユーザーまたはデータベースオブジェクトの所有者である必要があります。

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

外部テーブル、外部列、遅延バインドビューの列に関するコメントはサポートされていません。

例

次の使用例は、SALES テーブルにコメントを追加します。

COMMENT ON TABLE sales IS 'This table stores tickets sales data';

次の使用例は、SALES テーブルにコメントを追加します。

select obj_description('public.sales'::regclass);

obj_description
-------------------------------------
This table stores tickets sales data

次の使用例は、SALES テーブルからコメントを削除します。

COMMENT ON TABLE sales IS NULL;

次の使用例は、SALES テーブルの EVENTID 列にコメントを追加します。

COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';

次の使用例は、SALES テーブルの EVENTID 列 (列番号 5) にコメントを表示します。

select col_description( 'public.sales'::regclass, 5::integer );

col_description
-----------------------------------------
Foreign-key reference to the EVENT table.

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

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

コメントを表示するには、PG_DESCRIPTION システムカタログをクエリします。次の例は、EVENT テーブルの説明を返します。

select * from pg_catalog.pg_description
where objoid =
(select oid from pg_class where relname = 'event'
and relnamespace =
(select oid from pg_catalog.pg_namespace where nspname = 'public') );

objoid | classoid | objsubid | description
-------+----------+----------+----------------------------------------
116658 |     1259 |        0 | Contains listings of individual events.