数据库表说明文档导出(附导出效果图)
本文介绍了使用Docker部署database-export数据库表结构文档导出工具的全流程。该工具支持MySQL、Oracle等主流数据库,可一键导出Word/Excel/Markdown等格式文档。文章详细讲解了镜像拉取、容器启动(含解决Oracle时区报错的关键参数配置)、访问验证等步骤,并提供了常见问题解决方法。部署成功后,用户只需通过浏览器访问即可快速生成数据库文档,极大提升开发效率。文
前言:最进项目上需要导出一份数据库说明文档,经过网络筛选,这里选用了一种最方便简洁得方式(首先,我这docker环境),且不干扰现有开发环境,这里选用了database-export项目的容器部署的方式,database-export是一款超实用的数据库表结构文档导出工具,支持MySQL、Oracle、SQL Server等多种数据库,可一键导出Word、Excel、Markdown等格式文档,极大提升开发效率。本文详细讲解其Docker部署全流程,解决大家常遇到的Oracle时区报错(ORA-01882)、端口配置、镜像拉取失败等问题,全程亲测可用,新手也能轻松上手!
一、项目基础信息(必看)
-
项目名称:database-export(数据库表结构文档导出工具)
-
Gitee 地址:https://gitee.com/kimillee/database-export(官方源码,可查看详细功能)
-
使用镜像:pomzwj/database-export:4.1.0(亲测可拉取,稳定无报错)
-
核心功能:支持MySQL、Oracle、PostgreSQL等主流数据库,一键导出表结构文档(Word/Excel/Markdown/PDF/HTML),操作简单、效率极高,开发必备工具!
二、镜像导出、分享及加载方法(方便快速验证)
很多读者担心拉取的镜像与本文适配度不高,或想快速验证镜像是否符合需求,这里提供镜像导出、分享(供文档作者/分享者使用)和镜像加载(供读者使用)的完整步骤,命令可直接复制执行,无需复杂操作。
2.1 镜像文件已经提供,可以移步文章顶部下载链接,下载使用
(认为符合自己预期可以使用的话,建议去gitee上下载,或者去给开发者star。
2.2 镜像加载(读者操作,快速验证)
若你获取到上述导出的镜像tar包,无需从Docker仓库拉取,直接加载镜像即可,步骤如下(全程复制可用):
# 加载镜像(需确保tar包路径正确,此处为当前目录下的tar包)
docker load -i ./database-export-4.1.0.tar
# 加载成功后,验证镜像(查看是否存在 pomzwj/database-export:4.1.0 镜像)
docker images
关键提示:加载完成后,镜像名称和版本与本文一致,可直接执行后续“容器启动”命令,无需再执行“镜像拉取”步骤,快速验证镜像是否符合需求,避免拉取失败的问题。
三、Docker 完整部署步骤(全程复制可用)
提示:所有命令均已测试,直接复制粘贴即可执行,无需修改(除服务器部署需替换IP外),新手直接跟着走!
若已通过“镜像加载”获取镜像,可跳过步骤1(镜像拉取),直接执行步骤2和步骤3。
步骤1:拉取指定版本镜像(必执行,未加载镜像者)
避免使用latest版本出现兼容性问题,直接拉取经过测试的4.1.0版本,命令如下:
docker pull pomzwj/database-export:4.1.0
验证拉取成功:执行 docker images 命令,若能看到 pomzwj/database-export 镜像,且标签为4.1.0,说明拉取成功。
步骤2:清理旧容器(避免冲突,必执行)
若之前启动过同名容器或旧版本容器,需先停止并删除,防止端口冲突或配置异常,命令如下:
docker stop database-export && docker rm database-export
说明:若未启动过该容器,执行后提示“容器不存在”,直接忽略,继续下一步即可。
步骤3:启动容器(核心步骤,解决Oracle时区报错)
重点!启动命令已集成时区配置(彻底解决Oracle连接 ORA-01882: timezone region not found 报错)和开机自启,保留内外端口9999配置,直接复制执行:
docker run -d --name database-export -p 9999:9999 -e TZ=Asia/Shanghai -e JAVA_OPTS="-Duser.timezone=Asia/Shanghai" --restart=always pomzwj/database-export:4.1.0
四、核心命令参数详解(新手必看)
很多新手不清楚每个参数的作用,这里详细拆解,帮你理解并灵活调整(无需修改,了解即可):
| 参数 | 说明 |
|---|---|
| -d | 后台运行容器,不占用当前终端,部署后不影响其他操作 |
| –name database-export | 给容器命名,方便后续管理(如停止、删除、重启),可自定义,建议保留默认 |
| -p 9999:9999 | 端口映射,容器内外端口均为9999(外部访问用9999,内部容器端口也为9999),避免与其他程序端口冲突 |
| -e TZ=Asia/Shanghai | 设置容器系统时区为上海,解决容器与本地时区不一致的基础问题 |
| -e JAVA_OPTS=“-Duser.timezone=Asia/Shanghai” | 核心!强制Java程序使用上海时区,彻底解决连接Oracle数据库时出现的 ORA-01882 时区报错,新手必加 |
| –restart=always | 设置容器开机自启,Docker重启、服务器重启后,容器会自动启动,无需手动重新部署 |
| pomzwj/database-export:4.1.0 | 指定启动的镜像名称及版本,必须与步骤1拉取/加载的镜像一致,否则启动失败 |
五、启动成功验证(快速确认,避免白忙活)
1. 查看容器运行状态
docker ps
若输出结果中包含 database-export,且 STATUS 为Up(运行中),说明容器启动成功。
2. 访问工具页面(核心验证步骤)
打开浏览器,输入访问地址:
http://localhost:9999(本地部署,直接访问)
http://服务器IP:9999(服务器部署,替换为自己的服务器IP)
若能正常进入 database-export 工具界面,说明部署成功,可直接开始使用文档导出功能!
六、工具快速使用入门(新手友好)
部署成功后,简单几步即可导出数据库表结构文档,新手快速上手:
-
打开工具页面(http://localhost:9999 或 服务器IP:9999),点击【新增数据源】;
-
选择数据库类型(如Oracle、MySQL),填写数据库IP、端口、用户名、密码,点击【测试连接】,连接成功后保存;
-
选择需要导出的数据库和表,勾选导出格式(推荐Markdown/Word);
-
点击【开始导出】,等待几秒即可下载生成的文档,全程无需复杂配置!
-
导出效果(截取了导出结果的某个部分,仅作效果参考)

提示:连接Oracle时,无需额外配置时区,启动命令已自带修复,直接填写数据库信息即可连接成功。
七、常见问题解决(避坑必看,提升体验)
整理了部署过程中最常遇到的3个问题,附详细解决方法,新手直接对照排查!
-
问题1:拉取镜像失败(提示 pull access denied)
-
解决:确认拉取命令为
docker pull pomzwj/database-export:4.1.0,该镜像可直接拉取,无需Docker登录,若仍失败,检查网络连接或切换Docker镜像源;也可通过“镜像加载”方式获取镜像,跳过拉取步骤。 -
问题2:启动后访问不到页面(浏览器提示无法访问)
-
解决:① 执行
docker ps检查容器是否运行;② 确认端口9999未被其他程序占用(可执行netstat -an | findstr 9999排查);③ 核对启动命令中的端口映射是否为 9999:9999。 -
问题3:连接Oracle数据库报错 ORA-01882: timezone region not found
-
解决:确保启动命令中已添加两个时区参数(-e TZ=Asia/Shanghai 和 -e JAVA_OPTS=“-Duser.timezone=Asia/Shanghai”),停止容器后重新执行启动命令即可。
-
问题4:镜像加载失败(提示 no such file or directory)
-
解决:检查镜像tar包路径是否正确,确保命令中的路径(./database-export-4.1.0.tar)与tar包实际保存路径一致,若tar包在其他目录,需修改路径(如 /home/xxx/database-export-4.1.0.tar)。
八、常用容器管理命令(后续维护必备)
部署完成后,后续维护(停止、重启、排查问题)常用命令,收藏备用!
-
停止容器:
docker stop database-export -
删除容器:
docker rm database-export(需先停止容器) -
查看容器日志(排查启动失败原因):
docker logs -f database-export -
重启容器:
docker restart database-export -
查看镜像列表:
docker images -
删除镜像(无需使用时):
docker rmi pomzwj/database-export:4.1.0
结尾总结
本文详细讲解了 database-export 的Docker部署全流程,新增镜像导出、分享及加载方法,方便读者快速验证镜像,同时解决了Oracle时区报错、端口配置、镜像拉取/加载失败等核心痛点,全程亲测可用。
这款工具能极大提升数据库文档导出效率,开发、测试人员都能用到,建议收藏备用!如果部署过程中遇到其他问题,欢迎在评论区留言,看到会第一时间回复~
关键词:database-export、Docker部署、Oracle时区报错、数据库表结构导出、pomzwj/database-export、容器端口配置、Docker镜像导出、Docker镜像加载
博主互动:如果这篇教程帮到你,麻烦点赞+收藏+关注支持一下~ 部署或使用过程中遇到任何问题,评论区留言,博主第一时间回复排查!
补充说明:本文所有操作均基于Windows/Linux系统通用,Docker版本无特殊要求(建议20.10及以上),亲测CentOS、Ubuntu、Windows 10/11均可正常部署使用;镜像导出后可跨系统分享,加载后功能与拉取的镜像完全一致。
更多推荐
所有评论(0)