一键生成数据库文档的方法

首先放一张结果图

结果图

一、支持的数据库
Mysql、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL、Cache DB

二、配置方式（在一个springBoot项目中）
1.pom文件
引入screw核心包，HikariCP数据库连接池。HiKariCP是数据库连接池的一个后起之秀，号称性能最好，可以完美地PK掉其他连接池。
官网：https://github.com/brettwooldridge/HikariCP

        
            cn.smallbun.screw
            screw-core
            1.0.3
        
        
            com.zaxxer
            HikariCP
            3.4.5
        
        
            mysql
            mysql-connector-java
            8.0.20
        

2.screw核心配置
screw有两种执行方式，第一种是pom文件配置，第二种是代码执行。这里介绍一下pom文件配置的方式。

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
            
                cn.smallbun.screw
                screw-maven-plugin
                1.0.3
                
                    
                    
                        com.zaxxer
                        HikariCP
                        3.4.5
                    
                    
                    
                        mysql
                        mysql-connector-java
                        8.0.20
                    
                
                
                    
                    root
                    
                    LZJlzj123
                    
                    com.mysql.cj.jdbc.Driver
                    
                    jdbc:mysql://localhost:3306/t1
                    
                    HTML
                    
                    false
                    
                    freemarker
                    
                    
                    
                    数据库文档生成
                    
                    ${project.version}
                    
                    
                
                
                    
                        compile
                        
                            run
                        
                    
                
            
        
    

configuration中可以设置你要连接的数据库的用户名、密码以及数据库的表名等等。
fileType可以选择HTML、DOC、MD三种格式的文档。

导出方式

完成设置后，点击screw:run，即可进行导出。

3.结果查看
找到对应的idea项目所在的目录，此时里面会有一个doc文件夹，所生成的数据库表结构就在里面。

作者认为使用pom配置的方式更加简洁，如果对使用代码生成的方式感兴趣，可以参考这篇博客：https://juejin.im/post/6865485568038404103

妈妈再也不用担心我生成数据库文档了。