drawlib.diagrams.er（ER データベース図）

IE（Information Engineering / Crow's Foot：カラスの足跡）記法の多重度マーカーと、行単位で厳密に揃う外部キー列アンカーを備えたリレーショナルデータベース ER（Entity-Relationship）スキーマ図モジュールです。標準インポート: from drawlib.diagrams.er import Entity, ERDiagram, Relationship。

from drawlib.canvas import save, setup
from drawlib.diagrams.er import Entity, ERDiagram
from drawlib.fonts import FontRoboto, FontSourceCode
from drawlib.styles import Colors, Styles

setup(width=120, height=58)

erd = ERDiagram(
    node_style=Styles.Neutral.patch(text_font=FontSourceCode.ROBOTO_MONO, text_size=10.0),
    header_style=Styles.PrimaryNeutral.patch(text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0),
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.0),
)

users = erd.add(
    Entity("users", width=42, header_height=4.8, row_height=4.0)
    .add_column("id", "UUID", pk=True, nullable=False)
    .add_column("email", "VARCHAR", nullable=False)
    .add_column("created_at", "TIMESTAMP", nullable=False),
    xy=(27.0, 43.0),
)

products = erd.add(
    Entity(
        "products",
        width=42,
        header_height=4.8,
        row_height=4.0,
        header_style=Styles.SecondaryNeutral.patch(text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0),
    )
    .add_column("id", "UUID", pk=True, nullable=False)
    .add_column("sku", "VARCHAR", nullable=False)
    .add_column("price", "INT", nullable=False),
    xy=(27.0, 15.0),
)

order_items = erd.add(
    Entity(
        "order_items",
        width=44,
        header_height=4.8,
        row_height=4.0,
        header_style=Styles.PrimaryFlat.patch(
            text_color=Colors.White, text_font=FontRoboto.ROBOTO_BOLD, text_size=11.0
        ),
    )
    .add_column("id", "BIGINT", pk=True, nullable=False)
    .add_column("user_id", "UUID", fk=True, nullable=False)
    .add_column("product_id", "UUID", fk=True, nullable=False)
    .add_column("qty", "INT", nullable=False),
    xy=(92.0, 29.0),
)

users.connect(
    order_items,
    cardinality="1:*",
    start_column="id",
    end_column="user_id",
    start_side="right",
    end_side="left",
)
products.connect(
    order_items,
    cardinality="1:*",
    start_column="id",
    end_column="product_id",
    start_side="right",
    end_side="left",
)

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

typeCardinality#

Relationship の始点 start と終点 end に描画される IE（Crow's Foot）記法の多重度マーカーを指定する Literal 型です。

Cardinality = Literal["1:*", "1:1", "1:1..*", "1:0..1", "0..1:1", "0..1:*", "*:*"]

• 座標アンカー: 解決された start および end のテーブル枠線またはカラム行アンカーの直外に描画されます。

classColumnInfo#

Entity テーブル内の 1 カラム行を表すバリデーション付き Pydantic データモデルです。通常は entity.add_column(...) または entity.add_columns([...]) から生成します。

ColumnInfo(
    *,
    name: str,
    type: str = "",
    pk: bool = False,
    fk: bool = False,
    nullable: bool = True,
) -> None

• 座標アンカー: Entity カード内に 3 列整列（PK/FK バッジ | カラム名 name | データ型 type (NN)）で描画され、start_column / end_column に name を指定することでその行の Y 座標に直接コネクタを接続できます。

コンストラクタ引数・フィールド#

パブリックメソッド・プロパティ#

(このほか pydantic.BaseModel 標準の互換メンバー model_extra、model_fields_set、model_parametrized_name、model_post_init、model_rebuild、construct、copy、dict、from_orm、json、parse_file、parse_obj、parse_raw、schema、schema_json、update_forward_refs、validate を継承します。)

classERDiagram#

Entity テーブルカードおよび Crow's Foot 記法の Relationship コネクタを管理する ER データベーススキーマ図のトップレベルコンテナです。

ERDiagram(
    *,
    node_style: Style,
    edge_style: Style,
    edge_text_style: Style,
    title: str = "",
    title_style: Style | None = None,
    width: float | None = None,
    height: float | None = None,
    style: Style | None = None,
    header_style: Style | None = None,
) -> None

• 座標アンカー: draw(xy=(0.0, 0.0), align="bottom_left") は図のローカル原点 (0.0, 0.0) をキャンバス座標 xy に配置します（align="center" の場合は get_size() の中心を xy に配置）。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classEntity#

上部ヘッダーバナーと 3 列構成のスキーマ行（PK/FK バッジ、カラム名、データ型＋NULL 制約）を持つデータベーステーブルカードです。

Entity(
    name: str,
    width: float = 25.0,
    height: float | None = None,
    header_height: float = 4.0,
    row_height: float = 3.2,
    style: Style | None = None,
    header_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: erd.add(entity, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。注目テーブルのヘッダーに Styles.PrimaryFlat を用いる場合は、必ず header_style=Styles.PrimaryFlat.patch(text_color=Colors.White, text_size=11.0) を指定して白文字のコントラストを確保してください。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classRelationship#

2 つの Entity テーブル間を、カード辺中点または厳密な外部キーカラム行（start_column、end_column）で結ぶ Crow's Foot リレーションエッジです。

Relationship(
    start: Entity,
    end: Entity,
    cardinality: Cardinality = "1:*",
    start_side: Side = "auto",
    end_side: Side = "auto",
    start_column: str | None = None,
    end_column: str | None = None,
    label: str = "",
    style: Style | None = None,
    text_style: Style | None = None,
    routing: RoutingType = "orthogonal",
    padding: PaddingType = 0.0,
    show: bool = True,
) -> None

• 座標アンカー: start.get_anchor(start_side, start_column) と end.get_anchor(end_side, end_column) に接続されます。erd.connect(...)、entity.connect(...)、または erd.add_relationship(rel) で登録します。

コンストラクタ引数・属性#

typeRoutingType#

Relationship コネクタの経路計算方式を指定する Literal 型です。

RoutingType = Literal["orthogonal", "direct"]

• 座標アンカー: 解決された start と end のエンティティ／カラムアンカー間の補間経路を制御します。

typeSide#

Entity カード上の接続辺を指定する Literal 型です。

Side = Literal["left", "right", "top", "bottom", "auto"]

• 座標アンカー: "left" と "right" は start_column / end_column と組み合わせることでカラム行単位の Y スナップを行います。"auto" は対向する最近傍の辺を自動選択します。