首页
/ 使用tbls生成MySQL数据库文档与ER图的正确方法

使用tbls生成MySQL数据库文档与ER图的正确方法

2025-06-18 05:16:49作者:裘旻烁

tbls是一个优秀的数据库文档生成工具,能够自动从数据库中提取结构信息并生成文档和ER图。本文将详细介绍如何正确使用tbls工具生成MySQL数据库文档,特别是针对常见的配置错误进行解析。

基本配置方法

要使用tbls生成数据库文档,首先需要创建一个配置文件。标准的配置文件名为.tbls.ymltbls.yml,内容示例如下:

dsn: mysql://用户名:密码@主机地址:端口号/数据库名

例如连接本地MySQL的test数据库:

dsn: mysql://root:root@127.0.0.1:3306/test

生成文档的正确命令

配置好yml文件后,可以使用以下命令生成文档:

tbls doc -c tbls.yml

这个命令会在当前目录下创建一个dbdoc文件夹,包含以下文件:

  • schema.svg:整体数据库结构图
  • 各表的.svg文件:每张表的ER图
  • README.md:数据库概览文档
  • 各表的.md文件:每张表的详细文档
  • schema.json:数据库结构的JSON格式数据

常见错误解析

在实际使用中,用户可能会遇到"invalid database scheme"错误。这通常是由于命令参数使用不当造成的。例如:

tbls doc -c tbls.yml -f erd

这个命令会报错,因为tbls doc命令的参数解析顺序是[DSN] [DOC_PATH],而erd被错误地解释为数据源名称(DSN)。

正确生成ER图的方法

如果需要指定输出ER图的路径,有以下两种正确方式:

  1. 在配置文件中指定输出路径:
dsn: mysql://root:root@127.0.0.1:3306/test
docPath: erd_output

然后运行:

tbls doc -c tbls.yml
  1. 直接在命令行中指定输出路径:
tbls doc -c tbls.yml erd_output

版本兼容性说明

本文基于tbls 1.73.2版本编写。不同版本可能有细微差别,建议使用最新版本以获得最佳体验。可以通过以下命令查看当前版本:

tbls version

总结

tbls是一个功能强大的数据库文档生成工具,正确配置和使用可以大大提高数据库文档的编写效率。关键点包括:

  1. 确保yml配置文件格式正确
  2. 理解命令参数的正确顺序
  3. 合理指定输出路径
  4. 使用最新版本避免兼容性问题

通过本文的介绍,希望读者能够避免常见的配置错误,顺利生成所需的数据库文档和ER图。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8