COMMENT

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

表にコメントをつける

自分のスキーマ内にある表またはビューにコメントを付ける。

COMMENT ON TABLE table IS 'comment'

指定したスキーマ内にある表またはビューにコメントを付ける。

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

テーブル(表)にコメントを付けるSQL文の例を示す。

COMMENT ON TABLE emp IS '従業員表'

列にコメントをつける

自分のスキーマ内にある表またはビューの列にコメントを付ける。

COMMENT ON COLUMN table.column IS 'comment'

指定したスキーマ内にある表またはビューの列にコメントを付ける。

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

カラム(列)にコメントを付ける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'

SQL