db2doc

数据库文档工具
授权协议 MIT
开发语言 Java
所属分类 数据库相关、 数据库管理工具
软件类型 开源软件
地区 国产
投 递 者 张嘉
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

使用本工具可以迅速基于 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,可分别在数据目录下生成对应类型文档
 相关资料
  • Phinx 可以让开发者简洁的修改和维护数据库。 它避免了人为的手写 SQL 语句,它使用强大的 PHP API 去管理数据库迁移。开发者可以使用版本控制管理他们的数据库迁移。

  • 一、本功能说明 对全站数据进行导出备份或者将备份的数据库恢复 注意事项:   备份数据请确保根目录的caches文件夹具有写入权限。 二、子功能导航 1.数据备份 2.数据还原 3.数据修复 三、功能详解 1.数据备份 1).如何进入本功能 导航栏 选择扩展 -> 菜单栏 选择 数据库工具 2).界面解释 点击后显示如下界面 界面详述 1). 分卷大小: 您可以自行定义单个数据包文件的大小,不建议

  • 本文向大家介绍NoSQL反模式 - 文档数据库篇,包括了NoSQL反模式 - 文档数据库篇的使用技巧和注意事项,需要的朋友参考一下 我们设计关系数据库Schema的都有一套完整的方案,而NoSQL却没有这些。半年前笔者读了本《SQL反模式》的书,觉得非常好。就开始留意,对于NoSQL是否也有反模式?好的反模式可以在我们设计Schema告诉哪里是陷阱和悬崖。NoSQL宣传的时候往往宣称是Schema

  • 本文向大家介绍Laravel 5.2 文档 数据库 —— 起步介绍,包括了Laravel 5.2 文档 数据库 —— 起步介绍的使用技巧和注意事项,需要的朋友参考一下 1、简介 Laravel 让连接多种数据库以及对数据库进行查询变得非常简单,不论使用原生 SQL、还是查询构建器,还是 Eloquent ORM。目前,Laravel 支持四种类型的数据库系统: MySQL Postgres SQL

  • 我想在firestore数据库中查询文档id。目前我有以下代码: 我没有结果。但当我查询其他字段时,它会起作用: 文档id的名称是如何调用的?

  • 主要内容:添加数据源PyCharm支持各种类型数据库的接口支持。 当用户授予对创建的数据库的访问权限,它就会使用提供代码完成的SQL编写工具提供数据库的模式图。 在本章中,我们将重点介绍MySQL数据库连接,其中涉及以下步骤。 添加数据源 请注意PyCharm支持各种数据库连接,这一点很重要。 第1步 打开数据库工具窗口:View -> Tool Windows -> Database,并打开名为数据源和对话框的对话