数据库markdown文档生成

最近由于工作需要生成数据库文档,直接复制非常的麻烦。同时借鉴了一些其他的文档生成工具,于是开发了这样的一个数据库markdown文档生成工具。

db2md

数据库的markdown文档生成工具,Github地址

1 如何使用

  1. 下载代码
  2. 填写数据库信息:src/main/resources/db.properties
  3. 执行src/main/java/Run.java类的main方法。以默认配置导出到md/datasource.md文件

2 如何自定义

本项目支持自定义导出的列和顺序。修改注解信息即可

  • src/main/java/model/md/TableModel 表展示配置
  • src/main/java/model/md/ColumnModel 表字段展示配置

3 导出样例

以下为导出内容样例

模式表名说明
publicdemo1样例表1
publicdemo2样例表2
demo1
名称数据类型列大小允许空值默认值备注
iduuid2147483647NO主键
namevarchar255YES名称
created_datedate13YES创建日期
deletedbool1YESfalse是否删除
demo2
名称数据类型列大小允许空值默认值备注
iduuid2147483647NO主键
versionint819YES版本
updated_datedate13YES更新日期

希望对你们有帮助,有什么需求可以评论,后面想再完善一下。

  • 5
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值