最好用的数据库文档生成工具

用户飞天狐

一 前言

本文介绍一些比较流行的数据库文档生成工具，什么是数据库文档？ 其实在工作中进行项目交付的时候经常用到；简单来说数据库文档就是对整个数据库设计说明的文档，比如使用了哪个数据库，每张表的字段，类型说明等，然后整理成一个设计文档，这个文档多种多样，最常见的就是word，有了数据库文档对以后的数据库维护，或者进行二次开发都很方便；

二 流行的数据库文档生成工具


2.1 screw

最近比较火的一款数据库文档生成工具目前支持如下几种数据库，其它还在开发中

• MySQL
  
• MariaDB
  
• TIDB
  
• Oracle
  
• SqlServer
  
• PostgreSQL
  
• Cache DB
  

文档生成支持
文档生成支持

• html
  
• word
  
• markdwon
  

生成示例



使用方式 支持 java ,和 maven 插件, java方式看官方文档；
<build>
    <plugins>
        <plugin>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-maven-plugin</artifactId>
            <version>${lastVersion}</version>
            <dependencies>
                <!-- HikariCP -->
                <dependency>
                    <groupId>com.zaxxer</groupId>
                    <artifactId>HikariCP</artifactId>
                    <version>3.4.5</version>
                </dependency>
                <!--mysql driver-->
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.20</version>
                </dependency>
            </dependencies>
            <configuration>
                <!--username-->
                <username>root</username>
                <!--password-->
                <password>password</password>
                <!--driver-->
                <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                <!--jdbc url-->
                <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx</jdbcUrl>
                <!--生成文件类型-->
                <fileType>HTML</fileType>
                <!--打开文件输出目录-->
                <openOutputDir>false</openOutputDir>
                <!--生成模板-->
                <produceType>freemarker</produceType>
                <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                <fileName>测试文档名称</fileName>
                <!--描述-->
                <description>数据库文档生成</description>
                <!--版本-->
                <version>${project.version}</version>
                <!--标题-->
                <title>数据库文档</title>
            </configuration>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>run</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>项目地址： https://gitee.com/leshalv/screw
2.2 DBCHM

DBCHM 支持SqlServer/MySQL/Oracle/PostgreSQL/DB2/SQLite数据库。
支持的导出的文件格式；

• chm
  
• word
  
• excel
  
• pdf
  
• html
  
• xml
  
• markdown
  

效果展示



最新版本示 DBCHM.exe 软件，上手也容易；
项目地址：https://gitee.com/lztkdr/DBCHM
2.3 TableGo

TableGo是基于数据库的代码自动生成工具，低代码编程技术的实现，可以零代码自动生成SpringBoot项目工程、生成JavaBean、生成MyBaits的Mapper映射配置文件、生成数据库设计文档（Word、Excel）、生成Swagger2离线API文档、生成前后端代码、能查出数据库数据生成各种代码和文档等；
支持MySQL、Oracle、SQL Server、PostgreSQL、MariaDB五种数据库；
使用自定义模板功能可以根据数据库表结构信息生成你想要的任何代码，例如：Java、C#、C++、Golang、Rust、Python、Objective-C、Swift、VB、VC、SQL、HTML、JSP、JS、PHP、Vue、React、Word、Excel等；
界面展示：



详细介绍地址：https://blog.csdn.net/vipbooks/article/details/78767469
官网地址：http://www.tablego.cn/
公众号知识追寻者求关注关注吖
更多好用工具：
FinalShell一款全新的linux连接工具
Another Redis DeskTop Manager一款全新redis桌面连接工具
Docker 图形化页面管理工具使用
Java程序员必备的Intellij idea 插件 (zszxz.com)
.....

夜与牡丹共枕眠

DBCHB还不错，文中链接已不可打开，仓库地址已改成社区下： dotNET China/DBCHM

一笔定乾坤

GitHub - vran-dev/databasir: 数据库文档管理中心  再推荐一个 web 版的

乘奔御风

打不开

林燃

[大笑]上面的工具各有优缺点，因为这些优缺点我也自己造了个轮子，用WPF写了一款类似的数据库文档管理工具，目前支持SqlServer/MySql/PostgreSql等多种数据，可以导出CHM、Excel、Word、PDF、Html、Xml、Json、MarkDown等多种格式的文档，而且还支持对数据库表/视图/存储过程进行分组管理、导出。[大笑]开源地址：https://gitee.com/izhaofu/SmartSQL  查看图片