记一次使用screw 生成MySQL数据库文档

记一次使用screw 生成数据库文档

介绍

🚀 screw (螺丝钉) 英:[skruː] ~ 简洁好用的数据库表结构文档生成工具

特点

1. 支持多种数据库

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

2. 支持多种生成文档类型

   • MD(Markdown)
   • HTML
   • Word

普通方式

• 引入依赖

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>${lastVersion}</version>
 </dependency>

• 编写代码

/**
 * 文档生成
 */
  @Test
    public void shouldAnswerWithTrue() {
   
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        // 驱动  根据版本的原因 驱动名可能不一样
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/tobacco?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT");
        //用户名
        hikariConfig.setUsername("root");
        //密码
        hikariConfig.setPassword("a123");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径  若不存在会自动创建
                .fileOutputDir("/Users/lengleng")
                //打开目录  生成完是否自动打开文件夹
                .openOutputDir