BBH
-Biz Branding Hub-
投稿日 : 
2019/11/13
更新日 : 
2019/11/13

【postgreSQL】テーブルとテーブルへのコメントを一覧表示するSQLのサンプル

開発をしていると、名称だけでは何のテーブルなのか判断に迷う時があります。
ドキュメントが整備されていればいいのですが、こういう環境ではメンテナンスされていないことが多いです。
そんな時は、テーブルに対して付与されているコメントを確認してみるのも一つの手です。

postgreSQLでは、テーブルに対してコメントを設定することができます。
それを一覧表示するSQLのサンプルが以下になります。

postgreSQL

-- テーブルとテーブルへのコメントを一覧表示するSQL
select distinct temp.table_name, temp.table_comment
from
(
select
  psut.relname   as TABLE_NAME
  ,pd.description as TABLE_COMMENT
from
   pg_stat_user_tables psut
  ,pg_description      pd
where
  psut.relname like '条件式' -- 一覧表示したいテーブル名で条件抽出
  and
  psut.relid=pd.objoid
  and
  pd.objsubid=0) as temp
order by table_name;

これで、テーブルとそのコメントを一覧表示することができます。
ただし、これもコメントが設定されていること、それがメンテナンスされている保証はないので、そういう意味だとドキュメントとさほど信頼性は変わらないかもしれません。。。

Profile

管理人プロフィール

都内でITエンジニアをやってます。
変遷:中規模SES→独立系SIer→Webサービス内製開発
使用技術はその時々でバラバラですが、C#、AWSが長いです。
どちらかと言うとバックエンドより開発が多かったです。
顧客との折衝や要件定義、マネジメント(10名弱程度)の経験あり。
最近はJava+SpringBootがメイン。

Recommend