db2doc 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
db2doc 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
db2doc 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 fastjrun
适用人群 未知
收录时间 2021-10-27

软件简介

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

使用方法

下载源码并编译

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,可分别在数据目录下生成对应类型文档
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击引领话题📣
发表了资讯
2021/10/27 11:19

db2doc v1.0 发布,数据库文档生成工具

db2doc v1.0 已发布,使用本工具可以迅速基于 sql 生成markdown、html和word文档 依赖 h2 基于 spring-boot2.1.3 基于 https://gitee.com/rayson517/screw-pro 调整,增加了 h2 驱动 封装 Docker,同时支持 arm 和 x86 架构

1
21
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
0 评论
14 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部
返回顶部
顶部