tblsでデータベースドキュメントを生成する(1.ドキュメント生成編)

More than 1 year has passed since last update.



  1. ドキュメント生成編

  2. テーブル情報補完編

  3. CI連携編


tblsを使うと、1コマンドでデータベースドキュメントを生成できます。

https://github.com/k1LoW/tbls

Markdown形式で生成されますので、そのままGitHubなどのリポジトリにコミットして閲覧することができます(ドキュメントも更新履歴が残ったほうがいいですからね)。


インストール

tblsはGo製のCLIツールなのでgo getでインストールできます。

$ go get -u github.com/k1LoW/tbls

Macの場合はHomebrewでインストールすることも可能です。

$ brew install k1LoW/tbls/tbls


オプション: Graphviz のインストール

Graphvizの dot コマンドが使えると、dotコマンドを使って自動でER図も生成してくれますので、ER図が必要な場合はGraphvizもインストールしておきます。

$ brew install graphviz


データベースドキュメントの生成

tblsは現在、MySQLとPostgreSQLに対応しています。


MySQL

以下のようにユーザ名(user)、パスワード(pass)、ホスト名(hostname)、ポート(3306)、データベース名(dbname)と、ドキュメントのディレクトリ(./dbdoc)を指定して tbls doc を実行します。

$ tbls doc mysql://user:pass@hostname:3306/dbname ./dbdoc

これだけでデータベースドキュメントが生成されます。

これらをGitHubなどにコミットすれば、このような感じでコミット可能なドキュメントとしてデータベース情報を確認できます。

スクリーンショット 2018-06-11 23.24.11.png


PostgreSQL

PostgreSQLも同様です。

ユーザ名(user)、パスワード(pass)、ホスト名(hostname)、ポート(5432)、データベース名(dbname)と、ドキュメントのディレクトリ(./dbdoc)を指定して tbls doc を実行します。

$ tbls doc postgres://user:pass@hostname:5432/dbname ./dbdoc

(接続できない場合は ?sslmode=disable を付与してください)


たった1コマンドでデータベースのドキュメント生成ができました。

次はドキュメントにリレーション情報やコメントを補完する方法を紹介します。