【SQL】SQLのコメント文あれこれ

SQL

■ はじめに

SQLのコメント文について扱う

目次

【１】コメント文
　１）「--」
　２）「/＊ ＊/」
【２】テーブルに関するコメント文
　１）テーブルのコメントを付ける
　２）項目のコメントを付ける
【３】サンプル

【１】コメント文

１）「--」

* 一行コメント

２）「/＊ ＊/」

* 複数行コメント

【２】テーブルに関するコメント文

テーブルに関するコメント文
COMMENT ON TABLE / COMMENT ON COLUMN
について、扱う。

 １） テーブルのコメントを付ける

テーブル / Viewにコメント文を追加

構文 

COMMENT ON TABLE 【テーブル名/View名】 IS '【コメント文】';

２）項目のコメントを付ける

テーブル / Viewの項目にコメント文を追加

構文 

COMMENT ON COLUMN 【テーブル名/View名】.【項目名】 IS '【コメント文】';

【３】サンプル

PostgreSQLの場合 

-- テーブル
CREATE TABLE employee
(
    emp_id integer NOT NULL,
    emp_name varchar(50) NOT NULL,
    CONSTRAINT emp_id PRIMARY KEY (emp_id)
);

/*
 テストデータ
*/
COMMENT ON TABLE employee IS 'This is a sample table';
COMMENT ON COLUMN employee.emp_id IS 'Employee ID';
COMMENT ON COLUMN employee.emp_name IS 'Employee Name';

 参考文献

https://oracle-chokotto.com/ora_samplesql4.html

 関連記事

 CREATE TABLE / DROP TABLE ～ テーブル作成・削除 ～
https://dk521123.hatenablog.com/entry/2010/07/09/201233
 DBクライアントツール
https://dk521123.hatenablog.com/entry/2016/05/08/152815