首页
/ 推荐开源项目:Mermerd - 数据库ER图的Mermaid化神器

推荐开源项目:Mermerd - 数据库ER图的Mermaid化神器

2024-05-23 07:05:07作者:董宙帆
mermerd
Create Mermaid-Js ERD diagrams from existing tables

在数据库设计和管理过程中,清晰的实体关系图(ERD)是必不可少的。然而,手动绘制并保持更新这些图表可能相当耗时。这就是Mermerd的作用所在,它能帮助你从现有的数据库表中自动生成Mermaid-JS格式的ER图,让文档维护变得简单高效。

项目介绍

Mermerd是一个命令行工具,支持PostgreSQL、MySQL、MSSQL和Sqlite3等多种数据库,可以将你的数据库结构转化为易于读取和编辑的Mermaid语法。Mermaid是一种强大的文本标记语言,用于创建流程图、序列图、ER图等,广泛应用于GitHub等平台的Markdown文档中。

项目技术分析

Mermerd的工作流程简洁而高效:

  1. 通过指定的连接字符串连接到数据库。
  2. 选择要包含的模式(schema)。
  3. 然后从中选取感兴趣的表。
  4. 最后,享受由Mermaid-JS编写的ER图。

项目还提供了交互式CLI,允许多选、搜索表和模式,并支持CI/CD预设配置文件。

项目及技术应用场景

Mermerd非常适合以下场景:

  • 快速文档更新:当你需要更新数据库设计时,只需运行Mermerd,就能获得最新的ER图。
  • 原型设计与规划:在开发新功能或进行架构调整前,基于现有数据库结构生成ER图作为参考。
  • 团队协作:在Git仓库中以Markdown格式保存ER图,便于团队成员查看和讨论。
  • 自动化部署:将其集成进CI/CD流程,确保每次代码变更后自动更新ER图。

项目特点

Mermerd具备以下亮点:

  • 多种数据库支持:支持目前最流行的四种数据库类型,适应性强。
  • 自定义选项丰富:可以选择显示约束类型、忽略部分信息,还可以定义自己的关系标签。
  • 可交互性:提供交互式CLI,操作便捷,且支持多选和搜索,提高效率。
  • 易整合:生成的Mermaid语法可以直接用于Markdown,方便在GitHub等平台展示。

例如,你可以轻松地通过以下命令生成ER图:

# 使用预设配置文件
mermerd --runConfig yourRunConfig.yaml

# 指定连接字符串和模式
mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public

总的来说,Mermerd是一款强大的工具,能够减轻数据库ER图维护的负担,提升工作效率。如果你经常处理数据库设计工作,那么Mermerd绝对值得尝试。现在就去安装它,体验一下自动化的ER图生成吧!

mermerd
Create Mermaid-Js ERD diagrams from existing tables
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
671
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
8
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K