テーブル定義書の自動生成

ErdDocs は、SQL ダンプや Prisma スキーマからテーブル定義書を自動で作ります。全テーブルのカラム、データ型、NULL 可否、デフォルト値、主キー・外部キー、インデックス、リレーションを一つの資料にまとめます。ブラウザの印刷から PDF として保存できます。COMMENT に書いた日本語の論理名は説明欄に入ります。登録不要、スキーマはブラウザの外に出ません。

スキーマ

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS '顧客';
COMMENT ON COLUMN customers.email IS 'メールアドレス（ログインID、一意）';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS '商品（論理削除後も SKU を保持）';
COMMENT ON COLUMN products.stock IS '在庫数（倉庫連携で更新）';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS '注文ステータス：pending → paid → shipped → done、または cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS '注文明細（単価は購入時点で確定）';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS '顧客';
COMMENT ON COLUMN customers.email IS 'メールアドレス（ログインID、一意）';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS '商品（論理削除後も SKU を保持）';
COMMENT ON COLUMN products.stock IS '在庫数（倉庫連携で更新）';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS '注文ステータス：pending → paid → shipped → done、または cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS '注文明細（単価は購入時点で確定）';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

Your diagram appears here.

下のスキーマは COMMENT に論理名を書いた例です。「テーブル定義書」タブに切り替えると、論理名が説明欄に入ります。

データベースからテーブル定義書まで 3 ステップ

01スキーマを書き出します。PostgreSQL なら pg_dump --schema-only mydb > schema.sql、MySQL なら mysqldump --no-data mydb > schema.sql です。Prisma なら schema.prisma をそのまま使えます。
02上に貼り付けるか、ファイルをパネルにドロップします。スキーマを読み込むそばから定義書ができあがります。
03PDF で保存をクリックすると、ブラウザの印刷ダイアログから資料ができます。ここでもサーバーには何も送られません。

説明欄はスキーマから入ります（物理名と論理名）

データベースには説明を書く場所がもともと用意されていますが、そこに書いた説明が資料になることはめったにありません。日本のテーブル定義書では、コード上の物理名（books、loan_date）と、日本語の論理名（図書、貸出日）を並べるのが一般的です。ErdDocs では、論理名をデータベースのコメントとして書いておけば、そのまま定義書の説明欄に入ります。

PostgreSQL： COMMENT ON TABLE orders IS '…' と COMMENT ON COLUMN orders.status IS '…'。pg_dump はスキーマと一緒に自動で書き出します。
MySQL： CREATE TABLE の中で、カラム定義に書く COMMENT '…' 句と、テーブルの COMMENT= オプション。mysqldump はこれを残します。
Prisma： モデルやフィールドの上に書いた /// のドキュメントコメントが、説明として定義書に入ります。

それ以外はすべて DDL そのものから読みます。書かれたままの型、NULL 可否、デフォルト値、キー、インデックス、そして親テーブルの下にまとめたパーティションです。外部キーをまったく宣言していないダンプもあります（Rails や Django ではほとんど宣言しません）。その場合はカラムの命名からリレーションを推定し、推定したことを明記します。そのため監査する人は、宣言されたキーと推定したキーをいつでも見分けられます。

どんなときに求められるか

監査とコンプライアンス。 「テーブル定義書を出してください」はよくある依頼です。ErdDocs なら、貼り付けたスキーマのダンプから数分で応えられます。稼働中のデータベースを見ながら手で作れば、数日かかります。
納品と引き継ぎ。 受託開発の会社は、ドキュメントを添えてプロジェクトを締めくくります。ErdDocs はその成果物を、お客様が印刷して保管できる資料として作ります。
新メンバーのオンボーディング。 新しく入ったエンジニアは、information_schema をテーブルごとに調べる代わりに、資料を一つ読めば済みます。

Excel のテンプレートとの違い

Excel で定義書を管理すると、スキーマを変更するたびに誰かが手で直す必要があり、やがてデータベースと食い違います。ErdDocs ではダンプを貼り直すだけで最新の定義書になるので、納品やリリースのたびに作り直せます。

定義書に含まれるもの

テーブルごとに、カラム一覧（型・NULL・デフォルト・キー・説明）、参照先と参照元のリレーション、インデックス、CHECK 制約の許容値。全体には、主キーのないテーブルなどの注意点、外部キーを満たす INSERT／DELETE の順序、全カラムの索引がつきます。

よくある質問

生成されるテーブル定義書には何が載りますか？

ErdDocs はすべてのテーブルを記述します。テーブルごとに、宣言どおりのデータ型、NULL 可否、デフォルト値つきでカラムを並べます。さらに主キーと外部キー（参照先のカラムつき）、一意制約、インデックス、すべてのリレーションの両方向を載せます。スキーマにあるテーブルやカラムのコメントは説明になります。パーティション化されたテーブルは一度だけ載り、親の下にパーティション名が並びます。

既存のデータベースからテーブル定義書を作るには？

まずスキーマを SQL として出力します（PostgreSQL は pg_dump --schema-only、MySQL は mysqldump --no-data）。それを上に貼り付けて、「テーブル定義書」に切り替えます。ブラウザで印刷すると PDF になります。何もインストールせず、SQL が端末の外に出ることもありません。

説明欄にはどうやって内容が入りますか？

スキーマそのものから入ります。PostgreSQL の COMMENT ON TABLE 文と COMMENT ON COLUMN 文、MySQL のカラムに書く COMMENT 'テキスト' 句、Prisma の /// ドキュメントコメントが、すべて説明欄に入ります。コメントのないスキーマでは、説明欄を空のまま印刷せず、欄ごと省きます。

無料で使えますか？

ER図は 25 テーブルまで無料で表示できます。定義書は、つながりの多い 3 テーブルまで無料で全項目を表示し、それに続くテーブルは名前だけの枠として本来の位置に並び、残りは数だけを示します。実際に受け取る資料をそのまま確認できます。一度 $9 を支払うと、定義書全体と ER図全体が使えるようになります。サブスクリプションも更新もアカウントもありません。

スキーマはアップロードされますか？

いいえ。解析・ER図・定義書の作成はすべてブラウザの中で行われ、PDF もブラウザの印刷機能で作られます。アップロード先のサーバーがそもそもないので、スキーマがサーバーに届くことはありません。