tblsでデータベースのスキーマ情報をマークダウンで出力する

概要

DBのスキーマ情報をドキュメント化したいと思ったので使用したツールをメモします。

使用方法

tblsのgithubを参考。

dockerイメージの入手

$ docker pull k1low/tbls:latest

1コマンドでデータベースをドキュメント化できる手軽さ。

$ tbls doc postgres://dbuser:dbpass@hostname:5432/dbname

dockerでやる場合は以下です。

$ docker run --rm -v $PWD:/work k1low/tbls doc postgres://dbuser:dbpass@hostname:5432/dbname

筆者の場合は、mysqlなので、以下です。

$ docker run --rm -v $PWD:/work k1low/tbls doc mysql://dbuser:dbpass@hostname:3306/dbname