官方项目地址：

screw: 简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。

数据库支持

•  MySQL
•  MariaDB
•  TIDB
•  Oracle
•  SqlServer
•  PostgreSQL
•  Cache DB（2016）
•  H2 （开发中）
•  DB2 （开发中）
•  HSQL （开发中）
•  SQLite（开发中）
•  瀚高（开发中）
•  达梦 （开发中）
•  虚谷 （开发中）
•  人大金仓（开发中）

文档生成支持

•  html
•  word
•  markdown

生成的word文件效果图

直接使用

1、引入Maven依赖

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
</dependency>

2、编写代码

/**
 * PackageName: com.ruoyi.generator.doc.sql
 * ClassName: SqlBuildDocTest
 * Description: // TODO
 *
 * @author:Jc
 * @date:2024/5/29 下午2:37
 * Copyright (c) 2024, yangjiechao@dingtalk.com All Rights Reserved.
 */

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.Arrays;
import java.util.List;

class SqlBuildDocTest {

    /**
     * 主程序入口。
     * 主要功能是通过Hikari连接池配置数据库连接，并使用MyBatis Doc工具生成数据库结构文档。
     * 具体步骤包括：
     * 1. 配置Hikari连接池参数，包括数据库驱动、JDBC URL、用户名和密码等。
     * 2. 配置生成文件的相关参数，如输出目录、文件类型和模板实现方式等。
     * 3. 设置要忽略的表前缀。
     * 4. 配置需要处理的表和生成文档的详细配置，包括版本号、描述和数据源等。
     * 5. 执行文档生成操作。
     */
    public static void main(String[] args) {
        // 配置Hikari连接池
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/alp?useUnicode=true&characterEncoding=UTF8&useSSL=false&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=convertToNull");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        // 设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);

        // 配置生成文件相关参数
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("D:\\SqlDoc\\")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.WORD)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();

        // 忽略表前缀
        List<String> ignoreTablePrefix = Arrays.asList("gen_", "qrtz_", "sys_",);

        // 配置处理表的参数
        ProcessConfig processConfig = ProcessConfig.builder().ignoreTablePrefix(ignoreTablePrefix).build();

        // 配置生成文档的详细信息
        Configuration config = Configuration.builder().version("1.0.0").description("数据库结构说明文档").dataSource(dataSource).engineConfig(engineConfig).produceConfig(processConfig).build();

        // 执行生成文档操作
        new DocumentationExecute(config).execute();
    }
}