DB PostgresSQL

PostgreSQL コメント表示してみる

2017年2月22日

PostgreSQL コメント方法

PostgreSQLのテーブルとかカラムにコメント入れたけど表示されない!

しかし、オプションをつけることで表示することができました。

コメントの付け方

とりあえず表示させる前にコメントの付け方からおこないます。

MySQLみたいにテーブル作成時に付与したいけど出来ないみたいです。

テーブルコメント

テーブルへのコメントの仕方は、COMMENT ON TABLEの後に該当のテーブル名を指定して、ISを使ってテーブルへコメントを書きます。

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

カラムコメント

テーブル以外にもカラムに対してもコメントをすることができます。

カラムの場合は、COMMENT ON COLUMNでテーブル名.カラム名を指定します。

ほとんどテーブルの形式と一緒ですが、直接カラム名を指定しないでテーブル名.カラム名になります。

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

ここからが今回のやりたかった事

コンソール画面から確認します。

とりあえず、PostgreSQLへログインしてください。

コメント表示

通常通りに、\d テーブル名を指定してもコメントは表示されません。

// 通常カラム確認の場合
XX =# \d テーブル名 // これだと表示されない

コメントを表示させるには、\d+ テーブル名で指定します。

\dに+(プラス)をつける事で確認できる!

// コメント確認の場合
XX =# \d+ テーブル名

まとめ

MySQLだと表示できるのに、PostgreSQLだとオプションを付けないと表示できないです。

少しめんどくさいですね。

それでも\d+のプラスを付けるだけで表示されるので、特に最初からプラスをつけて覚えておけば問題ないでしょう。

-DB, PostgresSQL
-