mysql自动生成数据库设计文档

mysql生成数据库设计文档

引入jar包

<!-- screw核心 -->
<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.5</version>
</dependency>
<!--MySQL驱动-->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope>
</dependency>
<!-- HikariCP  数据库连接池-->
<dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version>
</dependency>

代码实现

 public static void main(String[] args) {//数据源HikariConfig hikariConfig = new HikariConfig();hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/applets-company?characterEncoding=UTF-8");hikariConfig.setUsername("admin");hikariConfig.setPassword("12345678");//设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);// 1、生成文件配置EngineConfig engineConfig = EngineConfig.builder()//生成文件路径(改成自己的生成路径).fileOutputDir("D:\\mysqldocument")//生成后是否立即打开目录.openOutputDir(true)//文件类型  有HTML、WORD、MD三种枚举选择.fileType(EngineFileType.HTML)//生成模板实现.produceType(EngineTemplateType.freemarker)//自定义文件名称.fileName("测试生成数据库文档").build();//忽略表名（可选）ArrayList<String> ignoreTableName = new ArrayList<>();ignoreTableName.add("cj_gs");// 忽略表前缀（可选）ArrayList<String> ignorePrefix = new ArrayList<>();//ignorePrefix.add("xxl_");// 忽略表后缀（可选）ArrayList<String> ignoreSuffix = new ArrayList<>();//ignoreSuffix.add("_user");// 2、配置想要忽略的表（可选）ProcessConfig processConfig = ProcessConfig.builder().ignoreTableName(ignoreTableName).ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build();//指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置//根据名称指定表生成//.designatedTableName(new ArrayList<>())//根据表前缀生成//.designatedTablePrefix(new ArrayList<>())//根据表后缀生成//.designatedTableSuffix(new ArrayList<>())//忽略表名//.ignoreTableName(ignoreTableName)//.build();// 3、生成文档配置（包含以下自定义版本号、标题、描述（数据库名 + 描述 = 文件名）等配置连接）Configuration config = Configuration.builder()//版本.version("1.0.0")//描述.description("数据库设计文档生成")//数据源.dataSource(dataSource)//生成配置.engineConfig(engineConfig)//生成配置.produceConfig(processConfig).build();// 4、执行生成new DocumentationExecute(config).execute();}

生成效果

备注：
添加表说明sql

  alter table 表名 comment '备注' ;

mysql自动生成数据库设计文档相关推荐

Java自动生成数据库设计文档（Word）
一.前言在日常的开发工作中,偶尔会遇到项目收尾需要提供数据库设计文档的情况.对这个文档的编写目前应该已经基本没有问题了,如果你还不知道如何编写该文档,可以参考如下文章. https://blog.c ...
自动生成数据库设计文档利器
目录 1.前言介绍 2.功能说明 3.编码实战 1.新建项目 2.导入依赖 3.启动类 4.工具类 5.测试 1.前言介绍今天给大家介绍一款非常还用的小工具,专门用到生成数据库设计文档的,非常简单. ...
mysql根据表结构自动生成表设计文档
最近总是接到要整理新增需求的文档任务, 其他的业务逻辑说明写起来倒还可以没问题, 每每到了,写表设计文档时,慢慢的粘贴就很是头疼刚好最近在学go 正愁没什么需求练手,就想写个根据表结构自动生成表设 ...
如何生成数据库设计文档
如何生成数据库设计文档 screw 什么是screw 特点支持生成的文档类型目前支持的数据库类型支持的模板类型如何使用? 遇到的问题 screw 官网地址: https://gitee.com ...
生成数据库设计文档小技巧
目录生成数据库设计文档小技巧利用数据库自身功能生成excel和word文档使用的软件环境说明查询所有表名查询所有列名设置excel 生成数据库设计文档小技巧利用数据库自身功能生成exce ...
SpringBoot 生成数据库设计文档工具
1.在项目的pom.xml里加上以上代码,配置想要生成的数据库的信息 <build><plugins><plugin><groupId>org.spri ...
用PDMReader工具生成数据库设计文档
你是否在为写庞大的数据库设计文档发愁,帮你轻松搞定,前提是你需要有pdm文件! 第一步:下载并安装PDMReader(见我的资源里); 第二步:打开PDMReader,新建项目:test: 第三步:在 ...
PowerDesigner生成数据库设计文档
1.说明使用PowerDesigner设计数据库表, 基于PowerDesigner设计数据库表, 生成数据库对应的表设计文档, PowerDesigner支持生成HTML.RTF和本地格式的文档, ...
通过表结构生成数据库设计文档
技术实现:Screw+javaFX 作用:通过引入screw核心包来实现Java 数据库文档,一键生成支持的数据库列表:MySQL .MariaDB .TIDB. Oracle. SqlServer. ...

mysql自动生成数据库设计文档

mysql自动生成数据库设计文档相关推荐

最新文章

热门文章