简洁好用的数据库表结构文档工具

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有、要么有、但都是手写、后期运维开发,需要手动进行维护到文档中,很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人,于是萌生了要自己写一个插件工具的想法,但由于自己前期在程序设计上没有很多造诣,且能力偏低,有想法并不能很好实现,随着工作阅历的增加,和知识的不断储备,终于在2020年的3月中旬开始进行编写,4月上旬完成初版,想完善差不多在开源,但由于工作太忙,业余时间不足,没有在进行完善,到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间,解决了很多问题 ,在仅有且不多的业余时间中、进行开源准备,于2020年6月22日,开源,欢迎大家使用、建议、并贡献。
  关于名字,想一个太难了,好在我这个聪明的小脑瓜灵感一现,怎么突出它的小,但重要呢?从小就学过雷锋的螺丝钉精神,摘自雷锋日记:虽然是细小的螺丝钉,是个细微的小齿轮,然而如果缺了它,那整个的机器就无法运转了,慢说是缺了它,即使是一枚小螺丝钉没拧紧,一个小齿轮略有破损,也要使机器的运转发生故障的...,感觉自己写的这个工具,很有这意味,虽然很小、但是开发中缺了它还不行,于是便起名为screw(螺丝钉)。

特点

  • 简洁、轻量、设计良好

  • 多数据库支持

  • 多种格式文档

  • 灵活扩展

  • 支持自定义模板

数据库支持

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

文档生成支持

  •  html
  •  word
  •  markdwon

文档截图

  • html

screw 数据库文档生成工具

screw 数据库文档生成工具

  • word

screw 数据库文档生成工具

  • markdwon

screw 数据库文档生成工具

screw 数据库文档生成工具

使用方式

普通方式

  • 引入依赖
<dependency>
</groupId>
</artifactId>
</version>
</dependency>
  • 编写代码
/**
 * 文档生成
 */
{
//数据源
();
);
);
);
);
//设置可以获取tables remarks信息
);
);
);
);
//生成配置
()
//生成文件路径
)
//打开目录
)
//文件类型
)
//生成模板实现
)
//自定义文件名称
();

//忽略表
<>();
);
);
//忽略表前缀
<>();
);
//忽略表后缀    
<>();
);
()
//指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置	
//根据名称指定表生成
<>())
//根据表前缀生成
<>())
//根据表后缀生成	
<>())
//忽略表名
.

相关文章: