数据库文档生成工具V1.0,解压后双击exe程序即可使用,大家有问题欢迎互相交流
数据库表结构说明文档是程序员了解业务系统非常重要的资料、另外项目验收的时候,也需要提供给甲方数据库字典相关的技术验收资料,针对一些大型业务系统,涉及的数据表可能达到几百张甚至上千张。大家在日常开发过程中可能所有的表都能记得很清楚,基于这个目的开发了这个开源的数据库文档生成工具,使用起来也非常方便,直接打开exe程序就可以正常运行,感兴趣的朋友可以下载免费使用,如有问题也可以互相交流!
一、软件介绍
今天给大家分享我自己编写的数据库表结构文档生成工具,方便大家在实际开发当中,可以很方便导出业务系统的表结构,也可以作为项目验收文档中数据库设计文档使用。这样可以大大减少编写数据库表结构文档的时间,有需要的朋友欢迎下载或者沟通交流!
二、技术框架
- 编程语言:C# ( Net Framework4.5.5)
- 开发工具:Visual Studio 2015
- 数据库技术框架:Dapper
- 导出Word文档:NPOI
- 访问方式:因为是WinForm窗体应用程序,Windows操作系统可以直接运行
三、功能介绍(持续完善当中)
- 支持SQLServer、MySQL(5.7、8.0)、SQLite 、PostgreSQL四种类型的数据,(目前还在持续完善更新当中)
- 支持Word、Html、MarkDown 三种文档格式的导出
- 导出内容包含数据表(字段详情、字段注释、长度、默认值等)、创建表脚本、视图及视图脚本、存储过程及脚本
- 支持生成文档的同时使用默认文档的编辑器直接打开生成的数据库说明文档
- 支持数据库备份(目前只支持SQLServer导出bak备份文件)
四、实现流程
基于Dapper数据库框架,动态获取数据库链接字符串进行数据库链接,
然后根据不同类型数据库获取表结构(获取数据库列表、获取数据表列表、获取表字段信息、获取视图信息、获取存储过程信息、获取创建表语句),
然后使用Npoi技术生成到Word文档、通过字符串拼接的方式生成到html、markdown文档。
五、运行效果
首先打开应用程序主界面如下,后续进行优化
支持四种生成文档类型:每次只能选择一种文档格式,推荐使用markdown格式
下图Word文档生成效果
Html文档生成效果
MarkDown文档效果