ER 図 (ERDiagram): リレーショナルスキーマと Crow's Foot 記法

ERDiagram は、物理データベーススキーマモデリングの業界標準である Information Engineering (IE) / Crow's Foot（カラスの足跡）記法に厳密に準拠してリレーショナルデータベースアーキテクチャを可視化します。

from drawlib.canvas import save, setup
from drawlib.diagrams.er import ERDiagram, Entity
from drawlib.styles import Styles

setup(width=98, height=24)

er = ERDiagram(
    node_style=Styles.Neutral,
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.5),
)

users = er.add(Entity(name="users", width=32.0), xy=(19.0, 12.0))
users.add_column("id", type="INT", pk=True)
users.add_column("email", type="VARCHAR(255)", nullable=False)
users.add_column("name", type="VARCHAR(100)")

orders = er.add(Entity(name="orders", width=32.0, style=Styles.PrimaryNeutral), xy=(79.0, 12.0))
orders.add_column("id", type="INT", pk=True)
orders.add_column("user_id", type="INT", fk=True)
orders.add_column("total", type="DECIMAL(10,2)", nullable=False)

users.connect(
    orders,
    cardinality="1:*",
    start_side="right",
    end_side="left",
    start_column="id",
    end_column="user_id",
    label="places",
)

er.draw(xy=(0.0, 0.0))
save()

1. 基本概念と基本的な使い方

ERDiagram は、er.add(entity, xy=(cx, cy)) によってリレーショナルな Entity テーブルを中心 (cx, cy) 基準で配置し、すべてのカラムが収まるよう effective_height を自動拡張しながら、自動 PK / FK キーバッジ付きの型付きスキーマ行を描画します。リレーションシップは業界標準の Information Engineering (IE) 方式 Crow's Foot の cardinality マーカーを描画し、start_column と end_column で主キー行・外部キー行へ直接スナップ接続できるほか、カスタムの header_style バンド、show=False による非表示、align="center" 配置をサポートします。

• 中心基準の Entity カードとキーバッジ (xy, pk, fk, nullable): er.add(entity, xy=(cx, cy)) は各テーブルを中心座標で配置し、.add_column(...) がアンバー色の PK タグや青色の FK タグを付与しながら effective_height を自動的に拡張します。
• IE 方式 Crow's Foot カーディナリティ (cardinality): entity.connect(...) と er.connect(...) は、全 7 種類の多重度（"1:*"、"1:1"、"1:1..*"、"1:0..1"、"0..1:1"、"0..1:*"、"*:*"）にわたる Information Engineering ベクターマーカーを描画します。
• 行レベルのカラムアンカー接続 (start_column, end_column): テーブル中央の汎用ポートではなく、"left" / "right" 側面の特定の主キー行・外部キー行へリレーションシップ線を直接スナップ接続できます。
• ヘッダースタイル・表示制御・中央配置 (header_style, show=False, align="center"): header_style で注目テーブルを強調したり、show=False でレイアウトを保ったままエンティティと接続済みの Crow's Foot 線を非表示にしたり、align="center" で xy を中心にスキーマ全体を配置したりできます。

2. コンストラクタとエンティティ定義

from drawlib.canvas import save, setup
from drawlib.diagrams.er import ERDiagram, Entity
from drawlib.styles import Styles

setup(width=52, height=26)

er = ERDiagram(
    node_style=Styles.Neutral,
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.5),
    title="User Schema",
    title_style=Styles.BlackBold.patch(text_size=13.5),
    width=52.0,
    height=20.0,
)

# Create entity table
users = er.add(Entity(name="users", width=42.0), xy=(26.0, 10.0))
users.add_column("id", type="INT", pk=True)
users.add_column("email", type="VARCHAR(255)", nullable=False)
users.add_column("created_at", type="TIMESTAMP")

er.draw(xy=(0.0, 0.0))
save()

パラメータリファレンス

ERDiagram クラス

Entity クラス

カラム定義（add_column・add_columns・ColumnInfo）

from drawlib.diagrams.er import ColumnInfo

# Single column & batch column registration
entity.add_column(name: str, type: str = "", pk: bool = False, fk: bool = False, nullable: bool = True) -> Entity
entity.add_columns(
    columns: Sequence[Sequence[Any] | ColumnInfo],
    # Each item is a ColumnInfo or tuple (name, [type, pk, fk, nullable])
) -> Entity

Relationship（entity.connect & er.connect）

登録・サイズ取得・描画メソッド

• er.add(entity, xy=(cx, cy), show: bool | None = None) -> Entity: エンティティテーブルを中心 (cx, cy) に配置し、ミュータブルな Entity を返します。
• entity.connect(target, cardinality="1:*", ..., show=True) -> Relationship または er.connect(start, end, cardinality="1:*", ..., show=True) -> Relationship（および er.add_relationship(rel) -> Relationship）: 2 つのエンティティを Crow's Foot 記法で接続し、ミュータブルな Relationship（rel.show、rel.style、rel.text_style）を返します。
• er.get_size() -> tuple[float, float]: ダイアグラム全体の (width, height) を返します。
• er.draw(xy=(0.0, 0.0), *, scale: float = 1.0) -> None: 左下 xy を基準として、テーブル形状、Crow's Foot マーカー、フォントサイズを scale 倍に比例スケーリングして ER 図を描画します。

3. サポートされるカーディナリティ記法一覧

from drawlib.canvas import save, setup
from drawlib.diagrams.er import ERDiagram, Entity
from drawlib.styles import Colors, Styles
from drawlib.text import text

setup(width=128, height=96)

er = ERDiagram(
    node_style=Styles.Neutral,
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.5),
)

# 7 supported Crow's Foot cardinality strings arranged in a clean 2-column catalog
specs = [
    # Left column (x_src=14, x_dst=49)
    ('"1:*"  (One-to-Many)', "1:*", 14.0, 49.0, 80.0, "Parent", "Child"),
    ('"1:1"  (One-to-One)', "1:1", 14.0, 49.0, 57.0, "Parent", "Child"),
    ('"1:1..*"  (Mandatory Child)', "1:1..*", 14.0, 49.0, 34.0, "Parent", "Child"),
    ('"1:0..1"  (Optional Child)', "1:0..1", 14.0, 49.0, 11.0, "Parent", "Child"),
    # Right column (x_src=79, x_dst=114)
    ('"0..1:1"  (Optional Parent 1:1)', "0..1:1", 79.0, 114.0, 80.0, "Parent", "Child"),
    ('"0..1:*"  (Optional Parent 1:N)', "0..1:*", 79.0, 114.0, 57.0, "Parent", "Child"),
    ('"*:*"  (Many-to-Many)', "*:*", 79.0, 114.0, 34.0, "Left", "Right"),
]

lbl_style = Styles.DarkBold.patch(text_size=10.5, text_color=Colors.Primary5)

for _title_str, card, x1, x2, y, src_name, dst_name in specs:
    e_src = er.add(Entity(name=src_name, width=16.0, style=Styles.PrimaryNeutral), xy=(x1, y))
    e_dst = er.add(Entity(name=dst_name, width=16.0, style=Styles.Neutral), xy=(x2, y))
    e_src.connect(e_dst, cardinality=card, start_side="right", end_side="left")

er.draw(xy=(0.0, 0.0))

for title_str, _card, x1, x2, y, _src_name, _dst_name in specs:
    text(((x1 + x2) / 2.0, y + 6.5), title_str, style=lbl_style)

save()

4. カラムアンカーを用いた EC リレーショナルスキーマ

次の 4 テーブル構成のスキーマ（users、orders、order_items、products）では、すべてのリレーションシップを対応する主キー行と外部キー行へ直接アンカー固定しています。

from drawlib.canvas import save, setup
from drawlib.diagrams.er import ERDiagram, Entity
from drawlib.styles import Styles

setup(width=114, height=82)

er = ERDiagram(
    node_style=Styles.Neutral,
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.5),
    title="E-Commerce Relational Database Schema",
    title_style=Styles.BlackBold.patch(text_size=13.5),
)

# Top row: users (left) -> orders (right)
users = er.add(Entity(name="users", width=34.0), xy=(21.0, 54.0))
users.add_column("id", type="INT", pk=True)
users.add_column("email", type="VARCHAR(255)", nullable=False)
users.add_column("name", type="VARCHAR(100)")
users.add_column("created_at", type="TIMESTAMP")

orders = er.add(Entity(name="orders", width=34.0, style=Styles.PrimaryNeutral), xy=(93.0, 54.0))
orders.add_column("id", type="INT", pk=True)
orders.add_column("user_id", type="INT", fk=True)
orders.add_column("total_cents", type="INT", nullable=False)
orders.add_column("status", type="VARCHAR(32)")

# Bottom row: products (left) -> order_items (right)
products = er.add(Entity(name="products", width=34.0), xy=(21.0, 14.0))
products.add_column("id", type="INT", pk=True)
products.add_column("sku", type="VARCHAR(64)", nullable=False)
products.add_column("title", type="VARCHAR(200)")
products.add_column("price_cents", type="INT", nullable=False)

order_items = er.add(Entity(name="order_items", width=34.0, style=Styles.SecondaryNeutral), xy=(93.0, 14.0))
order_items.add_column("id", type="INT", pk=True)
order_items.add_column("order_id", type="INT", fk=True)
order_items.add_column("product_id", type="INT", fk=True)
order_items.add_column("quantity", type="INT", nullable=False)

# Row-anchored relationships
users.connect(
    orders,
    cardinality="1:*",
    start_side="right",
    end_side="left",
    start_column="id",
    end_column="user_id",
    label="places",
)
orders.connect(
    order_items,
    cardinality="1:1..*",
    start_side="bottom",
    end_side="top",
    label="contains",
)
products.connect(
    order_items,
    cardinality="1:*",
    start_side="right",
    end_side="left",
    start_column="id",
    end_column="product_id",
    label="referenced by",
)

er.draw(xy=(0.0, 0.0))
save()

5. ベストプラクティスとガイドライン

1. カラム単位アンカーの積極活用: start_column と end_column を指定すると、外部キー属性と参照先の主キー属性が視覚的に直接結ばれ、直感的で完成度の高いスキーマ図になります。
2. テーブル幅の設計: 長いデータ型（例: VARCHAR(255)）を含むテーブルでは、width を 28.0〜34.0 キャンバス単位に設定すると見やすくなります。
3. 明示的なカーディナリティ文字列: 手動で矢印形状を指定するのではなく、常に明示的なカーディナリティ文字列（"1:*"、"1:1" など）を使用してください。