DBCHM - 最简单、最实用的数据库文档生成工具字段

末蓝、 2022-11-04 11:30 208阅读 0赞

### 项目介绍 ###

DBHCM 是一个对数据库文档生成工具！ 该工具从最初支持chm文档格式开始，通过开源，大家集思广益，不断改进，又陆续支持word、excel、pdf、html、xml、markdown等文档格式的导出。本项目力求做最简单、最实用的数据库文档(字典)生成工具！

### 支持的数据库 ###

*   SqlServer
 *   MySQL
 *   Oracle
 *   PostgreSQL
 *   DB2
 *   SQLite

### 主要功能 ###

*  对数据库表，列的批注(注释) 获取、编辑、保存。
 *  文档信息包含：序号 | 列名 | 数据类型 | 长度 | 小数位数 | 主键 | 自增 | 允许空 | 默认值 | 列说明
 *  根据文件导入进行更新批注(注释)：
    
     *   pdm 由`powerdesigner`设计数据库时产生。
     *   xml 由`visual studio`设置 实体类库的项目属性，勾选 XML文档文件 后生成项目时产生。
     *   xml 由`dbchm`的 XML导出 而产生。
 *  支持的导出的文件格式：
    
     *   chm
     *   word
     *   excel
     *   pdf
     *   html
     *   xml
     *   markdown

### 效果展示 ###

1 数据库连接配置示例

![数据库连接配置][9e22f2e5a91391fd2935f2b3a26fab53.png]

2 数据库连接管理

![数据库连接管理][a0ac550ec0e56d583fe1a47169ed2e4c.png]

3 表名模糊匹配

![表名模糊搜索][604cb16776ea46d593caa869f179e53e.png]

4 执行批注更新

![表批注更新][31d527d5f98c230d261cebd2302a2795.png]

5 导出CHM文件

![导出CHM文件][CHM]

6 表结构信息

![表结构信息][84442ce8afb8cecebcca2419fcd94012.png]

### 7 更多格式的效果，请[下载体验][Link 1]哈![:wink:][wink]！！ ###

### 贡献者 ###

*  @[trycache][] 主要开发者
 *  @[空无一物][Link 2] 先驱者

### 下载使用 ###

*  **[下载最新发行版本][Link 1]**，下载解压后，双击运行 `DBCHM.exe`。
 *  新功能内测，Bug修复早知道，最新功能尝鲜，请在共享中获取![:yum:][yum]！

### 其他工具 ###

*  [htmlhelp][]，生成chm文件时，需提前安装。
 *  [PDMToCHM][htmlhelp]，将PDM表结构文件导出到CHM文件。

### 常见问题 ###

*  连接不上，怎么办？
    
    1.  `连接数据库`界面填写的`连接信息`真的正确无误?
    2.  `数据库服务器`有`防火墙/安全组`限制？
    3.  用 [Navicat Premium][htmlhelp] 连接数据库服务器试试！
 *  连接数据库时，点了 `连接/测试` ，半天没响应？  
     可能是连接远程数据库网络不好的原因，可以把`连接超时`设置的小一些。
 *  dbchm可以连接上，但显示不了数据怎么办？
    
     *  导出文档前，数据库使用账号要给予`root级别`的权限，非root级别账号连接，可能会出现`表数据显示不全`或数据查询因权限不足，会`查不出来数据`！
     *  dbchm有Bug， [提Issue][Issue] 或 [进群里][Link 3] 反馈。
 *  表列的批注数据我想迁移，怎么办？
    
    1.  使用 dbchm 的 `XML导出`，对当前数据库的批注数据 就会导出一个xml文件。
    2.  点`数据连接`， 切换至 目标数据库连
    3.  再用`批注上载` 就可以选择刚刚的xml文件，如果数据库表结构相同，批注就会更新到目标数据库服上。
 *  数据库比较老，如 `Sql Server 2000 `，怎么使用dbchm？
    
    1.  下载安装 [Navicat Premium][htmlhelp]
    2.  连接上老旧的数据库服务器，将数据库表结构脚本导出。
    3.  找一台高版本的数据库服务器，新建一个临时数据库，将导出的脚本导入。
    4.  然后用dbchm连接高版本的数据库服务器。
 *  Oracle数据库连上之后，一直未响应，像卡死了一样，怎么办？  
     因为Oracle的 `列是否自增` 的sql语句，查询效率比较低，查的比较慢，没有卡死！！请耐心等待！！  
     PS：如果你有更好方法，欢迎提供改善建议，助力![:fist:][fist]该工具越来越好使！
 *  Oracle 11g、Oracle 12c测试连接显示“\[28040\]ORA-28040:没有匹配的验证协议”，目前群里及isuues反馈的问题
    
    可能11g以后的版本均会出现此项问题。
    
    该问题描述：navicat等工具可以直接连接，但是本程序连接不上有上述问题。
    
    目前想到的解决问题办法是，需在sqlnet.ora添加设置
    
        SQLNET.ALLOWED_LOGON_VERSION=8
          SQLNET.ALLOWED_LOGON_VERSION_SERVER=8
          SQLNET.ALLOWED_LOGON_VERSION_CLIENT=8
    
    参数值可设置8、10等，使用者可根据需要自行设置。
    
    ![ORA-28040修改兼容][ORA-28040]
    
    注意：改完后其他相关用户的密码必须重置,或直接更新为原来的密码也是可以的（修改密码sql示例：alter user System identified by oldpassword;），此项操作慎重。
    
    要么在建库的初期添加此参数，然后重置相关密码；要么新建测试环境，进行此项操作。
    
    如果你有更好的解决方法，欢迎提供改善建议

### 交流 ###

*  QQ交流群： ，推荐点击按钮入群，当然如果无法成功操作，请自行搜索群号132941648进行添加 ），其它疑问或idea欢迎入群交流！

转载地址：[https://gitee.com/lztkdr/DBCHM][https_gitee.com_lztkdr_DBCHM]

[9e22f2e5a91391fd2935f2b3a26fab53.png]: /images/20221023/5bedb86ae54e4bee976422510fec1a87.png
[a0ac550ec0e56d583fe1a47169ed2e4c.png]: /images/20221023/cf64217333a74d2daa8604eda8cf035e.png
[604cb16776ea46d593caa869f179e53e.png]: /images/20221023/c74d2fb41df8404fb39de8f50b8c09c3.png
[31d527d5f98c230d261cebd2302a2795.png]: /images/20221023/0bf72aeff40e4bd58283e579efed825b.png
[CHM]: /images/20221023/f121f030439d488e96e413d95d95df92.png
[84442ce8afb8cecebcca2419fcd94012.png]: /images/20221023/42ff5ecdb598484ea02df82adb732ded.png
[Link 1]: https://gitee.com/lztkdr/DBCHM/releases
[wink]: /images/20221023/e6d588f415dd4fcfbf9d66ac2abe4892.png
[trycache]: https://gitee.com/trycache
[Link 2]: https://gitee.com/lztkdr/
[yum]: /images/20221023/86bf67c104d34aa28aa9e75e2798812f.png
[htmlhelp]: https://gitee.com/lztkdr/DBCHM/attach_files
[Issue]: https://gitee.com/lztkdr/DBCHM/issues/new
[Link 3]: http://shang.qq.com/wpa/qunwpa?idkey=43619cbe3b2a10ded01b5354ac6928b30cc91bda45176f89a191796b7a7c0e26
[fist]: /images/20221023/d35c31e4b4cb4ed9858d7816ad28099a.png
[ORA-28040]: /images/20221023/53461cdd582f441aa4fbb5e77ddd56e9.png
[https_gitee.com_lztkdr_DBCHM]: https://gitee.com/lztkdr/DBCHM