zukucode
主にWEB関連の情報を技術メモとして発信しています。

SQL テーブルと列(カラム)にコメントを設定する方法

SQLでテーブルと列(カラム)にコメントを設定する方法を紹介します。

SQL CREATE文でテーブルを新規作成するで紹介した方法で、テーブルを作成する際に、一緒にコメントを論理名として登録することが多いです。

テーブルにコメントを設定する

例えばemployeeという名前(物理名)のテーブルに「従業員マスタ」というコメント(論理名)を設定したい場合は以下のようにします。

COMMENT ON TABLE employee IS '従業員マスタ'

COMMENT ON TABLE xxx IS 'yyy'の形式で指定します。

xxxはテーブルの物理名、yyyは設定するコメントを指定します。

カラムにコメントを設定する

例えば以下のテーブルのemployee_idfirst_nameのカラムにそれぞれコメントを追記します。

CREATE TABLE employee (
    employee_id NUMBER(8,0),
    first_name VARCHAR2(20)
)

1回のコマンドで1つのカラムにしかコメントを設定できないため、以下のように2回実行する必要があります。

COMMENT ON COLUMN employee.employee_id IS '従業員ID'
/
COMMENT ON COLUMN employee.first_name IS '名'
/

COMMENT ON COLUMN zzz.xxx IS 'yyy'の形式で指定します。

xxxはカラムの物理名、yyyは設定するコメント、zzzはテーブル名を指定します。

コメント付きCREATE文まとめ

以下のようなスクリプトを作成しておけば、コメント付きのテーブルを作成できます。

CREATE TABLE employee (
    employee_id NUMBER(8,0),
    first_name VARCHAR2(20)
)
/
COMMENT ON TABLE employee IS '従業員マスタ'
/
COMMENT ON COLUMN employee.employee_id IS '従業員ID'
/
COMMENT ON COLUMN employee.first_name IS '名'
/


関連記事