SQL COMMENT

COMMENTはテーブルやカラムにコメントを付けるSQL文です。テーブルやカラムに分かりやすい日本語で説明を付けることができます。

表またはビュー

COMMENT ON TABLE [schema].table IS 'comment'

schema: コメントを付ける表またはビューが存在するスキーマの名前を指定する。自分のスキーマ内にある表またはビューにコメントを付ける場合は、スキーマ名の指定を省略できる。
table: コメントを付ける表またはビューの名前を指定する。
comment: コメントを指定する。

表にコメントを付ける。

SQL> COMMENT ON TABLE emp IS '従業員表';

表からコメントを削除する。

SQL> COMMENT ON TABLE emp IS ' ';

COMMENT ON MATERIALIZED VIEW [schema].mview IS 'comment'

schema: コメントを付けるマテリアライズド・ビューが存在するスキーマの名前を指定する。自分のスキーマ内にあるマテリアライズド・ビューにコメントを付ける場合は、スキーマ名の指定を省略できる。
mview: コメントを付けるマテリアライズド・ビューの名前を指定する。
comment: コメントを指定する。

マテリアライズド・ビューにコメントを付ける。

SQL> COMMENT ON MATERIALIZED VIEW empdept IS '従業員ビュー';

COMMENT ON COLUMN [schema].table[.column] IS 'comment'

schema: コメントを付ける表、ビューまたはマテリアライズド・ビューが存在するスキーマの名前を指定する。自分のスキーマ内にある表、ビューまたはマテリアライズド・ビューにコメントを付ける場合は、スキーマ名の指定を省略できる。
table: コメントを付ける表、ビューまたはマテリアライズド・ビューの名前を指定する。
column: コメントを付ける列の名前を指定する。
comment: コメントを指定する。

表の列にコメントを付ける。

SQL> COMMENT ON COLUMN empno IS '従業員番号';

表の列からコメントを削除する。

SQL> COMMENT ON COLUMN empno IS ' ';

表に付けられたコメントはデータディクショナリ USER_TAB_COMMENTS、列に付けられたコメントはデータディクショナリ USER_COL_COMMENTS を問い合わせることで参照することができる。

テーブルのコメントを確認する。

SQL> SELECT COMMENTS FROM USER_TAB_COMMENTS WHERE TABLE_NAME = 'EMP';

カラムのコメントを確認する。

SQL> SELECT COMMENTS FROM USER_COL_COMMENTS WHERE TABLE_NAME = 'EMP' AND COLUMN_NAME = 'EMPNO';