経緯
最近ドキュメント関連をMarkdownで書くようにしていて、テーブル定義書をMarkdownで書けないか試してみました。
ネットで調べてみると、うまいことMarkdownに変換してくれるツールが見つからなかったので、自分でスクリプトを書いてみました。
ソースコード↓
MySQL_table_define
なにを出力しているのか??
- テーブル定義
- インデックス情報
の2つを出力しています。
コマンドとしては
# テーブル定義
show full fields from テーブル名
# インデクス情報
show index from テーブル名
となります。
それぞれ出力された情報から
必要かなーと思うところを抜き出し
Markdownで出力しています。
動作確認済みMySQLバージョン
- MySQL5.6.20
- おそらく5.6系なら動くと思われます。
- 5.5など古いバージョンでは動作を確認してません。
- 古いMySQLで実行した場合、セルがずれて表示される可能性もあります。
今後(予定)
information_schemaから、リレーションの情報を取ってきて出せるようにしようと考えてます。