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

目次

COMMENTの構文

表またはビューにコメントを付ける。

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

列にコメントを付ける。

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

コメントを付ける表又はビューが存在するスキーマの名前を指定する。自分のスキーマにあるテーブル又はビューにコメントを付ける場合は、スキーマ名の指定を省略できる。

table

コメントを付けるテーブル又はビューの名前を指定する。

column

コメントを付ける列の名前を指定する。

comment

コメントを指定する。

COMMENTの使用例

表にコメントを付けるSQL文の例を示す。

COMMENT ON TABLE emp IS '従業員表'

列にコメントを付けるSQL文の例を示す。

COMMENT ON COLUMN emp.empno IS '従業員番号'

コメントの確認

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

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

SELECT COMMENTS FROM USER_TAB_COMMENTS WHERE TABLE_NAME = 'EMP'

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

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