(Oracle) テーブルやカラムにコメントを付与する【COMMENT文】

(Oracle) テーブルやカラムにコメントを付与する【COMMENT文】

 

本記事では、oracleで
COMMENT文を使ってテーブルやカラムにコメントを付ける方法を紹介する。
コメントを付与すると、テーブルやカラムに分かりやすい日本語で説明を付けることができる。

 

コメントの種類は大別すると、

  1. テーブルにつけるコメント
  2. 列につけるコメント

 

の2種類に分けられる。
それぞれ順番に解説していく。

 

①テーブルにコメントをつける方法

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

COMMENT ON TABLE table IS 'comment'

 

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

COMMENT ON TABLE schema.table IS 'comment'

 

  • schema

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

  • table

コメントを付ける表またはビューの名前を指定する。

  • comment

コメントを指定する。

 

以下はテーブルにコメントを付けるSQL文の例

COMMENT ON TABLE student 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 '従業員番号'

 

 

コメントの確認

付与したコメントは、以下のテーブルに問い合わせることで参照することができる。

 

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

SELECT COMMENTS FROM USER_TAB_COMMENTS WHERE TABLE_NAME = 'student'

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

SELECT COMMENTS FROM USER_COL_COMMENTS WHERE TABLE_NAME = 'student' AND COLUMN_NAME = 'student_id'

 

 

関連記事

(SQL) EXISTS句【相関副問合せ】の使い方 〜存在チェックを実施する〜

 

https://docs.oracle.com/cd/E16338_01/server.112/b56299/statements_4009.htm

 

 

記事が気に入った方はシェアをお願いします!

コメントを残す

メールアドレスが公開されることはありません。