SmartSQL：基于WPF写的一款开源方便、快捷的数据库文档查询、生成工具

SmartSQL

最方便、快捷的数据库文档生成工具

🚩 一、项目介绍

SmartSQL 是一款数据库文档工具！
该工具从最初支持chm文档格式开始，通过开源，集思广益，不断改进，又陆续支持word、excel、pdf、html、xml、markdown等文档格式的导出。

🎯 本项目力求做最简单、最好用的数据库文档(字典)检索生成工具！

🍀 二、数据库支持

• ✅ SqlServer
• ✅ MySQL
• ✅ PostgreSQL
• • Oracle
• • DB2
• • SQLite

🥝 三、主要功能

文档的内容都包含什么？

• 表 序号 | 列名 | 主键 | 自增 | 数据类型 | 长度 | 允许NULL值 | 默认值 | 备注说明
• 视图 视图内容SQL脚本
• 存储过程 存储过程内容SQL脚本

🔹注：Oracle暂不会查询显示自增数据。

支持哪些文档格式的导出？

• ✅ CHM
• ✅ Word
• ✅ Excel
• ✅ PDF
• ✅ Html
• ✅ Xml
• ✅ MarkDown

更新表列的注释，有哪些方式？

• 通过 文件-导入备注，选择文件导入进行更新批注(注释)：
  • pdm 由powerdesigner设计数据库时产生。
  • xml 由visual studio设置 实体类库的项目属性，勾选 XML文档文件 后生成项目时产生。
  • xml 由SmartSQL的 XML导出 而产生。

🎉 四、工具截图

1 数据库连接

2 分组管理

3 快捷查询

4 导入备注

5 导出文档

6 设置

7 关于

🎉 五、文档截图

1 CHM文档

2 HTML文档

📘 五、更新日志

​ ReleaseNote

💪 六、作者

• @MicLuo MicLuo

🍻 七、贡献代码

• SmartSQL 遵循 Apache-2.0 开源协议，欢迎大家提交 PR 或 Issue。

⬇️ 八、下载地址

• 立即下载，下载解压后，双击运行 SmartSQL.exe。

🐵 九、开源地址

码云：https://gitee.com/izhaofu/SmartSQL

GitHub：https://github.com/TeslaFly01/SmartSqlT

🍄 附一、其他工具

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

⚡ 附二、近期计划

• 收集问题，修复完善基础功能
• C#实体代码生成
• 表、视图、存储过程同步功能
• 对象结构对比功能
• ...

📖 附三、常见问题

• 连接不上，怎么办？

  1. 连接数据库界面填写的连接信息真的正确无误?
  2. 数据库服务器有防火墙/安全组限制？
  3. 用 Navicat Premium 连接数据库服务器试试！

• 连接数据库时，点了 连接/测试 ，半天没响应？

  可能是连接远程数据库网络不好的原因，可以把连接超时设置的小一些。

• SmartSQL可以连接上，但显示不了数据怎么办？

  • 导出文档前，数据库使用账号要给予root级别的权限，非root级别账号连接，可能会出现表数据显示不全或数据查询因权限不足，会查不出来数据！
  • SmartSQL有Bug， 提Issue 反馈。

• 表列的批注数据我想迁移，怎么办？

  1. 使用 SmartSQL 的 XML导出，对当前数据库的批注数据 就会导出一个xml文件。
  2. 点数据连接， 切换至 目标数据库连
  3. 再用批注上载 就可以选择刚刚的xml文件，如果数据库表结构相同，批注就会更新到目标数据库服上。

• 数据库比较老，如 Sql Server 2000 ，怎么使用SmartSQL？

  1. 下载安装 Navicat Premium
  2. 连接上老旧的数据库服务器，将数据库表结构脚本导出。
  3. 找一台高版本的数据库服务器，新建一个临时数据库，将导出的脚本导入。
  4. 然后用SmartSQL连接高版本的数据库服务器。

• chm文件可以正常导出，但是文件名中文乱码，打开显示 无法访问此页

  这种情况，有一种可能是win系统的区域设置，勾选了

  Beta 版：使用Unicode UTF-8提供全球语言支持 。取消勾选后，可能不存在该问题。

• 其他问题

  如遇其他问题，可以通过Issues反馈，记录问题，请写清楚遇到问题的原因、软件版本、系统环境、数据库版本、甚至数据库结构、复现步骤以及期望达到的效果；建议配上多张全屏大图，请勿使用局部截屏小图！方便我们这边可以迅速定位，解决问题。

PS：如果你有更好方法，欢迎提供改善建议，助力✊该工具越来越好使！