db2doc数据库文档工具

使用本工具可以迅速基于 sql 生成 markdown、html和word文档

• 依赖 h2
• 基于 spring-boot2.1.3
• 基于https://gitee.com/rayson517/screw-pro 调整，增加了h2驱动
• 封装Docker，同时支持arm和x86架构

使用方法

下载源码并编译

git clone https://gitee.com/fastjrun/db2doc.git
cd db2doc
mvn clean package -Pnocheck

target 目录下生成 db2doc.jar

部署

db2doc.jar,db2doc.sh 部署到同一目录下，比如 /opt

cd /opt
sh db2doc.sh demo ./ word

参数说明

• 第一个参数为数据库脚本文件名称（不带 sql 后缀），如示例 sql 脚本名称为 demo.sql ,则上述命令参数位置为demo
• 第二个参数为数据目录，数据库脚本文件需要放在本目录，后续数据库文档也会生成在该目录
• 第三个为生成文档类型，可为 html、word 和 md，可分别在数据目录下生成对应类型文档

docker 部署

不想看源码的可以直接用这个 docker 镜像 pi4k8s/db2doc:1.0，这个镜像不仅可以在一般 x86 服务器使用，也可以在树莓派 4B 上直接使用

docker run --rm -v $(pwd):/opt/data/ -e DB_NAME=demo -e DATA_DIR=/opt/data/ -e DOC_TYPE=word pi4k8s/db2doc:1.0

参数说明

• DB_NAME：数据库脚本文件名称（不带 sql 后缀），如示例 sql 脚本名称为 demo.sql,则上述命令参数位置为 demo
• DATA_DIR：数据目录，数据库脚本文件需要放在本目录，后续数据库文档也会生成在该目录
• DOC_TYPE：生成文档类型，可为 html、word 和 md，可分别在数据目录下生成对应类型文档