6 Star 23 Fork 7

fastjrun / db2doc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

数据库文档工具

使用本工具可以实时连接数据库快速生成 markdown、html和word格式的数据库文档

  • 依赖h2
  • 基于spring-boot2.1.3
  • 基于https://gitee.com/leshalv/screw 开发,理论上支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB等
  • 通过浏览器维护
  • 封装Docker,同时支持arm和x86架构

使用方法

下载源码并编译

git clone https://gitee.com/fastjrun/db2doc.git
cd db2doc
sh build.sh package_server

output目录下生成db2doc.jar

部署

原生部署

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

cd /opt/db2doc
# 采用后台部署方式  
INIT=always nohup sh db2doc.sh &

容器化部署

也可以直接通过docker镜像pi4k8s/db2doc:2.0进行部署,这个镜像不仅可以在一般x86服务器使用,也可以在树莓派4B上直接使用

docker run -itd --name db2doc -p 8080:8080 \
-e JAVA_OPTS="-Xms1g -Xmx1g" pi4k8s/db2doc:2.0

使用

  • 数据库连接记录维护

http:{ip}:8080

输入图片说明

通过本配置页可添加多条数据库连接记录。

  • 测试连接

维护好记录后可点击操作列的"测试连接"按钮测试配置连接是否OK。

  • 导出数据库文档

支持导出markdown和word文档直接下载,导出html格式文档可直接在浏览器浏览。

MIT License Copyright (c) 2021 fastjrun Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

使用本工具可以实时连接数据库快速生成 markdown、html和word格式的数据库文档,已确认支持MySQL/Oracle/db2 展开 收起
MIT
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/fastjrun/db2doc.git
git@gitee.com:fastjrun/db2doc.git
fastjrun
db2doc
db2doc
master

搜索帮助