More than 3 years have passed since last update.

PostgreSQLにコメントを設定する

Posted at 2021-07-07

当記事はPostgreSQLのDATABASE、TABLE、COLUMNにコメントを付ける方法を記載します。

例えば、下記のようなテーブル名があったとします。

t_order_detail

上記のテーブルをA5M2などサードパーティ製のツールでDBを見た時に日本語名が分かりずらいですよね？
そんな時はコメントを付けると、サードパーティ製ツールで物理名称(英字)と論理名称(日本語）が両方表示されて見やすくなります。

この記事は、その方法について謡っています。

データベースに日本語名称を付与

下記のSQLを実行します。

COMMENT ON DATABASE 英字データベース名 IS '日本語データベース名';

下記のSQLを実行します。

COMMENT ON TABLE 英字テーブル名 IS '日本語テーブル名';

下記のSQLを実行します。

COMMENT ON COLUMN 英字テーブル名.英字カラム名 IS '日本語カラム名';

ちなみに
コメントを削除する際は、下記を参考にしてください。
上記で日本語名称だった部分をIS NULLにするとＯＫです。

COMMENT ON COLUMN 英字テーブル名.英字カラム名 IS NULL;

以上です。