SQLDiagram：从SQL文件自动生成数据库关系图

SQLDiagram：从SQL文件自动生成数据库关系图

【免费下载链接】sqldiagram CLI to generate Entity Relationship Diagram from SQL file 项目地址: https://gitcode.com/gh_mirrors/sq/sqldiagram

项目介绍

SQLDiagram 是一个命令行界面工具，专门用于从 SQL 文件自动生成精美的实体关系图。该工具采用离线工作模式，通过解析 SQL 语句直接转换为图形表示，无需学习额外的图表描述语言。

核心特性

• 离线工作：无需网络连接即可生成图表
• 美观样式：基于 D2 绘图库提供专业的视觉效果
• 智能解析：直接解析 SQL 语言，无需额外学习成本
• 分组管理：支持按文件分组显示表格，提升可读性

快速安装

确保系统已安装 Go 环境，然后执行以下命令：

go install -v github.com/RadhiFadlillah/sqldiagram

使用方法

基础命令格式

sqldiagram mysql [命令选项] [参数...]

常用选项说明

• --no-group, --ng：不将单独文件渲染为分组（默认：false）
• --raw-d2, --raw：以原始 D2 脚本形式渲染（默认：false）
• --output, -o：指定输出文件路径（如为空则使用标准输出）
• --direction, --dir：图表方向（up|down|right|left，默认 right）

实战示例

基础图表生成

以下命令将 Wordpress 数据库 SQL 文件转换为关系图：

sqldiagram mysql --dir down wordpress.sql > erd.svg

分组图表展示

通过将 SQL 文件按功能分组，可以生成更有组织的图表：

sqldiagram mysql --dir right grouped > erd.svg

支持的操作类型

SQLDiagram 目前支持以下 DDL 命令：

• CREATE TABLE
• DROP TABLE
• ALTER TABLE DROP COLUMNS
• ALTER TABLE ADD COLUMNS
• ALTER TABLE RENAME COLUMNS
• ALTER TABLE CHANGE COLUMNS
• ALTER TABLE ADD CONSTRAINT

技术限制

• 目前仅支持 MySQL 方言，不支持 PostgreSQL
• 关系线绘制在表之间而非列之间
• 输出格式限于原始 D2 语言或 SVG
• 关系仅以普通箭头表示

应用场景

数据库架构审查

在数据库重构过程中，使用 SQLDiagram 快速生成当前设计的关系图，帮助团队成员理解变更内容。

文档自动化

将图表生成集成到持续集成流程中，实现数据库文档的自动更新和维护。

最佳实践

• 模块化设计：按业务域拆分 SQL 文件，提升图表组织结构
• 版本控制：将生成的图表纳入版本管理系统，追踪数据库结构演进
• 流程集成：在构建流水线中自动执行图表生成命令

通过 SQLDiagram，开发者可以轻松创建专业的数据库关系图表，提升团队协作效率和数据库设计的可视化水平。

【免费下载链接】sqldiagram CLI to generate Entity Relationship Diagram from SQL file 项目地址: https://gitcode.com/gh_mirrors/sq/sqldiagram