SQLをMarkdownに変換
共同制作をあまりしてこなかったのでドキュメントが散らかりがちでだったのですがAIの力で過去に作ったものもドキュメント化していってます。
データベースの構造をドキュメント化するにあたり、今まではエクセルなどの表計算ソフトでデータベースの構造を残してたのですが、AIによると下記の3つに残すのが小規模な一般的な個人開発の一般的な方法らしい。
- schema.sql（CREATE TABLEを全部書いたDDL（最終仕様のソース））
- tables.md（テーブル定義書（上記の表形式でMarkdown化））
- erd.png（ER図のスクショ）
schema.sqlは｀mysqldump -u ユーザー名 -p --no-data データベース名 > schema.sql｀でみたいな形で簡単に書き出せる。
erd.pngはtables.mdがあればdbdiagram.ioのようなWEBツールで作成できる。
あとはschema.sqlをtables.mdに変換しできれば最低限の形が整うのですが変換ツールが見つからなかったので作ってみた。
https://tools.uda2.com/sql2md.html
とはいえ、コアな部分はAI（Claude）に作ってもらったので特に書くことは無い。
（しかも、今回のこの記事はカバー画像もAI（chatGPT）に作ってもらった。）
私がしたのは軽い修正とウダツールスのパッケージに収めただけです。