「このテーブル、どこに繋がってるんだっけ?」

「この user_id はどのテーブルの外部キーだろう?」「このテーブル、実はどこからも参照されていない?」——マイグレーションファイルやレビュー中のSQLを目で追ってリレーションを把握するのは、頭の中でパズルを組み立てるような作業です。

SQL to ER図 変換ツール は、CREATE TABLE 文を貼り付けるだけで、テーブル・カラム・主キー・外部キーの関係をMermaidのER図として即座に描画します。すべてブラウザ内で処理され、SQLは一歩も外に出ません。

SQL DDLからER図を自動生成する方法|CREATE TABLEを可視化

この記事では、ツールがどうやってDDLをパースしているかという実装の内側と、それゆえに知っておくべき対応範囲を解説します。

使い方

CREATE TABLE users (
  id BIGINT PRIMARY KEY,
  name VARCHAR(255) NOT NULL
);

CREATE TABLE orders (
  id BIGINT PRIMARY KEY,
  user_id BIGINT NOT NULL,
  total_amount INTEGER NOT NULL,
  FOREIGN KEY (user_id) REFERENCES users(id)
);

これを貼り付けると、次のMermaid erDiagram コードが生成されます。

erDiagram
    users {
        BIGINT id PK
        VARCHAR name
    }
    orders {
        BIGINT id PK
        BIGINT user_id
        INTEGER total_amount
    }

    orders }|--|| users : "user_id -> id"

生成されたコードはGitHubのREADMEやPull Requestにそのまま貼り付ければ描画されます。

パースの仕組み:正規表現でDDLを分解する

パーサーはSQL専用の構文解析ライブラリを使わず、正規表現ベースの軽量パーサー(SqlParser.parseDdl)で実装されています。処理の流れは3段階です。

① コメント除去とステートメント分割

const cleanSql = sql
    .replace(/--.*$/gm, '')           // 行コメント除去
    .replace(/\/\*[\s\S]*?\*\//g, '') // ブロックコメント除去
    .trim();

const statements = cleanSql.split(';').map(s => s.trim()).filter(Boolean);

; で単純分割しているため、カラムのデフォルト値に ; を含むような特殊なDDLには対応していません(実務ではほぼ発生しないケースです)。

② カラム定義を「括弧の外側のカンマ」で分割する

CREATE TABLE の本体をカンマで区切る際、素直に split(',') すると DECIMAL(10, 2) のような型定義の中のカンマまで割れてしまいます。そこで、括弧の深さを数えながら分割する専用関数を使っています。

private static splitByCommaOutsideParens(text: string): string[] {
    let depth = 0;
    // '(' で depth++, ')' で depth-- し、depth === 0 のカンマだけを区切りとして扱う
    for (let i = 0; i < text.length; i++) {
        if (text[i] === '(') depth++;
        else if (text[i] === ')') depth--;
        if (text[i] === ',' && depth === 0) { /* ここで分割 */ }
    }
}

これは JSON⇔CSV変換ツール のCSVパーサーで使った「状態を持つ1文字ずつの走査」と同じ発想です。SQLのカラム定義とCSVの引用符付きフィールドは、見た目は違えど「区切り文字が特定の状況下では無効になる」という性質が共通しています。

③ 各行を PRIMARY KEY / FOREIGN KEY / カラム定義に分類する

分割した各行を正規表現でパターンマッチし、3種類に振り分けます。

// テーブルレベルの主キー: PRIMARY KEY (id, tenant_id) のような複合キーにも対応
const pkMatch = trimmed.match(/PRIMARY KEY\s*\(([\s\w,`"]+)\)/i);

// テーブルレベルの外部キー
const fkMatch = trimmed.match(
    /FOREIGN KEY\s*\(([\s\w`"]+)\)\s*REFERENCES\s*(?:['\`"]?(\w+)['\`"]?\.)?['\`"]?(\w+)['\`"]?\s*\(([\s\w`"]+)\)/i
);

// カラム定義: `id BIGINT PRIMARY KEY` のようなインライン主キー・外部キーも解析
const colMatch = trimmed.match(/^['`"]?(\w+)['`"]?\s+(\w+(?:\([\w\s,]+\))?)(.*)$/i);

REFERENCES の正規表現は、カラム定義の末尾(インライン外部キー)とテーブルレベルの FOREIGN KEY 句の両方に対応しています。主キーは複合キーもサポートしており、PRIMARY KEY (id, tenant_id) のような定義は、該当する2カラムの両方に PK マークが付きます。

出力:Mermaidのカラス足記法

生成されるリレーション行は }|--|| というカラス足記法です。

orders }|--|| users : "user_id -> id"

}|(多)から ||(1)へ向かう矢印で、「複数の注文が1人のユーザーに属する」という1対多を表現しています。この記法の読み方や、他のパターン(1対1、多対多、識別/非識別関係)を体系的に知りたい場合は MermaidのER図記法リファレンス にまとめています。

なお、Mermaidの erDiagram はカラムの型に括弧を含められない仕様のため、VARCHAR(255) のような長さ指定は自動的に VARCHAR に短縮されます(type.replace(/\([^)]*\)/g, ''))。

対応していないDDLパターン

正規表現ベースの軽量パーサーゆえの制約もあります。SQLの構文解析器(パーサージェネレータ)を使わない設計は「バンドルサイズを抑えてブラウザで高速に動かす」ためのトレードオフで、次のパターンは認識されません。

パターン 対応状況
CREATE TABLE 内の PRIMARY KEY / FOREIGN KEY(テーブル・カラムどちらのレベルも) ✅ 対応
複合主キー PRIMARY KEY (a, b) ✅ 対応
ALTER TABLE ... ADD [CONSTRAINT ...] FOREIGN KEY / ADD PRIMARY KEY(pg_dump の出力形式) ✅ 対応
CREATE TABLE IF NOT EXISTS ✅ 対応
スキーマ修飾 schema.table_name ✅ 対応(テーブル名部分のみ抽出)
-- 行コメント//* */ ブロックコメント ✅ 除去してから解析

マイグレーションツールやpg_dumpは、外部キーを別の ALTER TABLE 文で後付けするスタイルで出力します(RailsのActiveRecordなど)。外部キーと主キーを追加する ALTER TABLE は読み込まれ、リレーションと主キーに反映されます。列の追加・変更など、それ以外の ALTER TABLE は反映されません。

ER図を確認するときのチェックポイント

  • 主キーが各テーブルに設定されているか
  • 外部キーの向きが意図通りか
  • 孤立しているテーブルがないか
  • 中間テーブルが多対多の関係を正しく表しているか

Pull Requestのレビューでは、SQL差分だけを見るよりもER図を添えたほうが影響範囲を共有しやすくなります。生成したMermaidコードをそのままレビューコメントに貼り付けられるのも、テキストベースで扱える利点です。

図を動かして整える

自動配置の図は、テーブルが増えると読みにくくなります。SQL to ER図 変換は、CREATE TABLE を貼って「ER図にする」を押すと、テーブルと外部キーの線を自動で並べたうえで、テーブルをドラッグで動かせる図として表示します。

  • 線は他のテーブルをよけて直角に引かれます。外部キーの列の行から出て、参照先の列の行に入ります
  • 端の記号は鳥足記法です。外部キー側が「多」、参照される側が「1」、NULL を許す列には円が付きます
  • その場で編集できます。テーブル名・列(名前・型・PK・NOT NULL・UNIQUE)・関係線を、図を見ながら直せます
  • 「Mermaid」タブでは、これまでどおり Mermaid のコードと画像を確認できます。図を編集すると、Mermaid にも反映されます
  • PNG / SVG / JSON での書き出しと、CREATE TABLE 文のコピーに対応します。JSON で保存しておけば、スキーマが変わったときに読み込んで直せます

読みやすくするコツは3つです。親(マスタ)は左、子(トランザクション)は右に置く。多対多の中間テーブルは両方の親の間に置く。テーブルが多いときは機能ごとに図を分けて、それぞれ JSON で保存する。なお、Mermaid の出力には位置の情報は含まれません。

スキーマの比較・点検・サンプルデータ、SQL Server の出力

SQL to ER図 変換ツールは、図を描くだけでなく、貼った CREATE TABLE を材料に、次のこともできます。

  • 2つのスキーマの比較(マイグレーション SQL): 古い CREATE TABLE と新しい CREATE TABLE を貼ると、テーブル・列・型・NULL 可否・DEFAULT・主キー・外部キーの差分から、ALTER TABLE を作ります(作成 → 追加・変更 → 外部キー → 削除の順)。PostgreSQL・MySQL・SQLite・SQL Server に対応します。列やテーブルの削除(データが消える)と、実行前に確認したい文(DEFAULT のない NOT NULL の追加・型の変更・主キーの変更・制約名が要る操作・SQLite でできない変更)には、印と理由が付きます。削除と追加の組から、改名かもしれない列・テーブルも警告します(マイグレーションは削除して作り直すので、改名ならデータが消えます)
  • スキーマの点検: 主キーがない・xxx_id なのに外部キーがない・外部キーの列にインデックスがない・snake_case と camelCase の混在・30 列を超える・長さのない VARCHAR を指摘します
  • インデックスの提案: 外部キーの列に付ける CREATE INDEX を出します。親の行を消すときや結合のときに、全件を読まないようにするためです
  • サンプルのデータ: 外部キーを守った INSERT を作ります(親のテーブルが先・主キーは連番・列名と型に合う値・seed で再現できる・1〜100 行)
  • SQL Server の出力: 方言の選択に SQL Server があります。型は INT・NVARCHAR・BIT・DATETIME2・UNIQUEIDENTIFIER、識別子は [角括弧]、自動採番は IDENTITY(1,1) になります。RESTRICT は SQL Server にないので NO ACTION にします

いずれも、SQL の定義だけを読む処理です。データベースには接続せず、データも見ません。 結果は、実行する前に必ず内容を確認してください。

よくある質問

MySQLやPostgreSQLのDDLでも使えますか?

CREATE TABLE を中心とした一般的なDDLであれば、MySQLやPostgreSQLの定義確認に使えます。方言固有の型やオプション(ENGINE=InnoDB など)は無視され、テーブル・カラム・キー情報の抽出には影響しません。

外部キーがないSQLでもER図になりますか?

外部キー制約がない場合でも、テーブルとカラムの一覧として可視化できます。ただしリレーションの線は FOREIGN KEY / REFERENCES の情報を元に作られるため、関連を明確に出したい場合はDDLに含めてください。

ALTER TABLEで追加した外部キーは認識されますか?

はい。ALTER TABLE ... ADD FOREIGN KEY と ADD PRIMARY KEY(ADD CONSTRAINT 名前 付きも可)は読み込まれ、リレーションと主キーに反映されます。列の追加・変更など、それ以外の ALTER TABLE は反映されません。

生成した図はドキュメントに貼れますか?

はい。Mermaid形式で出力してGitHubのREADMEや設計ドキュメントに貼れば、コードに近い形で構成図を管理できます。カラス足記法の読み方は MermaidのER図記法リファレンス を参照してください。

テーブルの位置を自分で動かせますか?

動かせます。「図(動かせる)」タブでテーブルをドラッグできます。矢印キーで微調整もでき、元に戻す・やり直しにも対応します。「自動で並べ直す」で最初の配置に戻せます。

2つのスキーマの差分から ALTER TABLE を自動で作れますか?

作れます。ただし、定義の差分だけを見るので、データの扱いは判断できません。列やテーブルの削除には「データが消える」印が付き、DEFAULT のない NOT NULL の追加や型の変更には「実行前に確認」の印が付きます。名前だけが変わった列は、削除と追加として出るため、改名かもしれない組を警告します。実行の前に、必ず内容を確認してください。

DBML・PlantUML でも書き出せる

ER図の編集欄の下に、「DDL をコピー」のほか 「DBML をコピー」「PlantUML をコピー」 のボタンがあります。DBML は dbdiagram.io に、PlantUML は PlantUML のエディタやドキュメントツールにそのまま貼れます。

Table orders {
  id INT [pk]
  customer_id INT [not null]
}

Ref: orders.customer_id > customers.id [delete: cascade]
  • DBML: 列の設定は pk・increment・not null・unique・default で、リレーションは Ref: 子.列 > 親.列(一対一は -)です。複合主キーは、列ごとの pk ではなく indexes ブロックに書きます
  • PlantUML: entity で表を描き、主キーは * と <<PK>> を付けて線の上に置きます。リレーションは 親 ||--o{ 子(外部キーが NULL を許すときは |o--o{)です
  • 外部キーの ON DELETE / ON UPDATE は、DDL から読み取って、DDL の書き出しと DBML の [delete: …, update: …] に反映されます

まとめ

  • パースは正規表現ベースの軽量実装。括弧の深さを見てカンマを分割する処理が肝
  • PRIMARY KEY・FOREIGN KEY(テーブル/カラムどちらのレベルも)・複合主キーに対応
  • ALTER TABLE による外部キー・主キーの後付けは対応。列の追加・変更など、それ以外の ALTER TABLE は反映されない
  • 生成コードはMermaidのカラス足記法。読み方は別記事のリファレンス参照

手元のSQLをそっとツールに預けて、見えていなかったテーブル間の関係を確認してみてください。