脱EXCEL！既存のデータベースからテーブル定義書を作ろう
k1LoW/tblsとは?
https://github.com/k1LoW/tbls
コマンドライン１つで、既存DBと接続し、データベースの定義をmarkdown形式で出力してくれる便利なツールです。
インストール方法
macの場合、homebrewでインストール可能
brew install k1LoW/tap/tbls
Dockerでも可能
docker pull k1low/tbls:latest
ドキュメント作成方法
Add .tbls.yml ( or tbls.yml ) file to your
repository.
tbls.ymlファイルを作成し、以下のように記載します
# 接続先
## {db}データベース種別
## {user}データベースユーザー
## {pass}データベースパスワード
## {port}ポート
## {host}ホスト
## {dbname}データベース名
dsn: {db}://{user}:{pass}@l{host}:{port}/{dbname}
# 出力先
docPath: docs/db
tbls.ymlを作成後、下記を実行するだけでデータベース定義書をmarkdownで作成できます。
tbls doc
出力されたmdファイルを見やすくする方法は別途記事にします。
