読者です 読者をやめる 読者になる 読者になる

プログラマーな日々

プログラマーをやっています。好きなツール:WorkFlowy、好きな言語:C#、好きなサービス:Backlog、好きなAWS:AWS Lambda。

pgAdminでPostgreSQLのテーブル定義書を出力する

PostgreSQL

pgAdminはGUIのPostgreSQL管理ツールです。インストール手順は以下をご覧ください。
PostgreSQL用GUI管理ツールpgAdminを入れてみた - プログラマーな日々
PostgreSQL用GUI管理ツールpgAdminを入れてみました。 ...

pgAdminを使うと、HTML形式でPostgreSQLのテーブル定義書を出力できます。テーブルやカラムに設定したコメントも出力されます。

コメントの設定方法

pgAdminで設定する

オブジェクトのプロパティを表示し、コメント欄に入力します。

SQLで設定する
  • テーブルにコメントを設定する
COMMENT ON TABLE hoge_table IS 'ほげテーブルの説明';
  • カラムにコメントを設定する
COMMENT ON COLUMN hoge_table.hoge_flg IS 'フラグです。0:無効 1:有効';
参考

COMMENT
COMMENT  -- オブジェクトのコメントの定義、または変更

テーブルの一覧

ここではテーブルを例としてスクリーンショットを紹介しますが、同じ手順でビュー、シーケンスも出力できました。トリガー関数と関数も出力できると思います(未確認)。

出力方法


出力されるレポート


テーブル定義書

出力方法

pgAdminで目的のテーブルを右クリックし、以下のメニューを選択します。

出力されるレポート


その他のレポート

ここではテーブルを例としてスクリーンショットを紹介しますが、同じ手順で他のオブジェクトでも出力できると思います(未確認)。

プロパティレポート


統計レポート