【Oracle12c】コメントの付与と表示SQL文

Oracle12cでテーブルを作成した際、

カラム名が物理名（英語名）になっており論理名（日本語名）を付けたい!!

また付与したコメントを表示させたいことありませんか。

そんな時に使えるコメント付与とコメント表示のSQLについてまとめました。

ゆりグル

SQL文だけ知りたい人はSQL文まとめまで飛んでね

コメントを付与する理由
コメントを付与するSQL文
コメントを表示するSQL文
SQL文まとめ

コメントを付与する理由

ビギン

カラムに名前を付けてるからコメント付けなくてもいいんじゃない？

ゆりグル

カラム名は大抵英語でつけるから、
日本語名でコメントでつけておくと見やすいよ!!

テーブルを作成する時のカラム名は英語でつけます。
英語のカラム名を物理名といいます。そして日本語名を論理名といいます。

テーブル定義を見てみるとわかりやすいです。

テーブル論理名：EMP
テーブル物理名：社員マスタ

項目No.	主キー	論理名	物理名	データ型	必須
1	1	社員番号	EMPNO	NUMBER(4)	〇
2		社員名	EMPNAME	VARCHAR2(50)	×
3		年齢	AGE	NUMBER(2)	×
4		部署番号	DEPTNO	NUMBER(4)	×
5		部署名	DEPTNAME	VARCHAR2(50)	×

コメントを付与するSQL文

先程のテーブル定義書を元に作ったテーブルにコメント付与し、テーブルとカラムに論理名を付けていきます。

テーブル作成SQL

CREATE TABLE スキーマ名.テーブル名 ( 
EMPNO NUMBER(4) NOT NULL,
EMPNAME VARCHAR2(50),
AGE NUMBER(2),
DEPTNO NUMBER(4),
DEPTNAME VARCHAR2(50), 
PRIMARY KEY(EMPNO) 
)

Osqleditで実行

テーブルにコメントを付与するSQL

COMMENT ON TABLE テーブル名 IS 'コメント';

Osqleditで実行

カラムにコメントを付与するSQL

COMMENT ON COLUMN テーブル名.カラム名 IS 'コメント';

Osqleditで実行

コメントを表示するSQL文

次はコメントの表示のSQL文について紹介します。
付与したコメントを見たいときに便利です。

テーブルのコメントを表示するSQL

SELECT * FROM USER_TAB_COMMENTS
WHERE TABLE_NAME ='テーブル名';

Osqleditで実行

カラムのコメントを表示するSQL

SELECT * FROM USER_COL_COMMENTS
WHERE TABLE_NAME ='テーブル名';

Osqleditで実行

SQL文まとめ

コメントを付与に関するSQLまとめ

テーブルにコメントを付与するSQL

COMMENT ON TABLE テーブル名 IS 'コメント';

カラムにコメントを付与するSQL

COMMENT ON COLUMN テーブル名.カラム名 IS 'コメント';

コメントを表示に関するSQLまとめ

テーブルのコメントを表示するSQL

SELECT * FROM USER_TAB_COMMENTS
WHERE TABLE_NAME ='テーブル名';

カラムのコメントを表示するSQL

SELECT * FROM USER_COL_COMMENTS
WHERE TABLE_NAME ='テーブル名';