ジモトを良くする会社

脱EXCEL!k1Low/tblsで既存のデータベースからテーブル定義書を作ろう...

ホームkeyboard_arrow_rightブログ
keyboard_arrow_right

脱EXCEL!k1Low/tblsで既存...

脱EXCEL!k1Low/tblsで既存のデータベースからテーブル定義書を作ろう 

2023年11月1日

永田 優樹

k1LoW/tblsとは?

https://github.com/k1LoW/tbls

コマンドライン1つで、既存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ファイルを見やすくする方法は別途記事にします。

記事を書いたメンバー

代表, プロジェクトマネージャー

永田 優樹

元ダイビングインストラクター。あだ名は「たいしょう」。
東京でシステム開発のプロジェクトマネジメントをしていたが、家族との時間、子供との時間をもっと大切にしたいと考え2019年に独立、辻堂でグッドローカルを立ち上げた。
クライアントに対してホスピタリティをもった提案をすることを信条に、地元を盛り上げようと奮闘中の三児のパパ。

Blog

関連ブログ

お気軽にお問い合わせください

システムに関すること、湘南への移住をお考えの方、中古リノベーションに関すること、
ジモトをワクワクさせる取り組みをしたいなど、皆様からのお問い合わせをお待ちしております。

050-3733-2229

電話での受付は行っていません。

ご質問などがあれば、

お問い合わせフォーム

をご利用ください。