如何基于SQLAlchemy ORM自动生成带列级关联的ER图？

以下几个工具能满足你精准显示主键与外键列级关联的需求：

SQLAlchemy-Schemadisplay #

这是SQLAlchemy生态下的专用工具，专门针对ORM模型生成列级精准关联的ER图，箭头会直接指向对应的关联字段。

用法： #

1. 安装依赖：

pip install sqlalchemy-schemadisplay

2. 结合你的ORM代码生成图（以添加关联表为例）：

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.orm import declarative_base, relationship
from sqlalchemy_schemadisplay import create_schema_graph

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    fullname = Column(String)
    nickname = Column(String)
    addresses = relationship("Address", back_populates="user")

class Address(Base):
    __tablename__ = 'address'
    id = Column(Integer, primary_key=True)
    email_address = Column(String, nullable=False)
    user_id = Column(Integer, ForeignKey('user.id'))
    user = relationship("User", back_populates="addresses")

# 生成ER图
graph = create_schema_graph(
    metadata=Base.metadata,
    show_datatypes=True,  # 显示字段类型
    show_indexes=True,   # 显示索引
    rankdir='LR',        # 横向布局
    concentrate=False    # 不合并箭头
)
graph.write_png('er_diagram.png')  # 保存为PNG

生成的图中，address.user_id会有箭头精准指向user.id，完全呈现列级关联关系。

PyGraphviz 自定义生成 #

如果需要高度自定义ER图样式，可直接用PyGraphviz解析SQLAlchemy元数据，手动构建节点和边，完全控制箭头指向与标注。

用法： #

1. 安装依赖：

pip install pygraphviz sqlalchemy

2. 自定义生成代码：

import pygraphviz as pgv
from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.orm import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    fullname = Column(String)
    nickname = Column(String)

class Address(Base):
    __tablename__ = 'address'
    id = Column(Integer, primary_key=True)
    email_address = Column(String, nullable=False)
    user_id = Column(Integer, ForeignKey('user.id'))

# 初始化图
G = pgv.AGraph(directed=True, rankdir='LR')

# 添加表节点和列
for table in Base.metadata.tables.values():
    # 用HTML表格渲染表结构
    table_label = f"<<TABLE BORDER='0' CELLBORDER='1' CELLSPACING='0'>\n<TR><TD BGCOLOR='lightblue'><B>{table.name}</B></TD></TR>"
    for column in table.columns:
        # 主键标红突出显示
        col_style = "<B><FONT COLOR='red'>{}</FONT></B>" if column.primary_key else "{}"
        col_label = f"<TD>{col_style.format(column.name)} ({column.type})</TD>"
        table_label += f"\n<TR>{col_label}</TR>"
    table_label += "\n</TABLE>>"
    G.add_node(table.name, label=table_label, shape='plaintext')

# 添加外键关联边（精准指向列）
for table in Base.metadata.tables.values():
    for fk in table.foreign_keys:
        source_col = f"{table.name}.{fk.parent.name}"
        target_col = f"{fk.column.table.name}.{fk.column.name}"
        G.add_edge(source_col, target_col, arrowhead='normal')

# 保存图
G.draw('custom_er_diagram.png', prog='dot')

运行后会生成从外键列直接指向主键列的箭头，样式可根据需求自定义调整。

SchemaSpy（结合临时数据库） #

SchemaSpy是一款强大的数据库文档工具，能生成带列级关联的ER图。由于它直接扫描数据库，可先让SQLAlchemy将ORM模型同步到临时数据库，再用它扫描。

步骤： #

1. 生成临时SQLite数据库：

from sqlalchemy import create_engine
engine = create_engine('sqlite:///temp.db')
Base.metadata.create_all(engine)

2. 下载SchemaSpy后，运行扫描命令：

java -jar schemaspy.jar -t sqlite -db temp.db -o schemaspy_output

3. 打开输出目录中的schema.html，里面的ER图会清晰展示每个外键列对应的主键列，箭头精准指向关联字段。

内容的提问来源于stack exchange，提问作者omoshiro