net开发的开源数据库文档查询、生成工具 SmartSQL

一、项目介绍

SmartSQL 是一款方便、快捷的数据库文档查询、导出工具！该工具从最初支持CHM文档格式开始，通过不断地探索开发、集思广益和不断改进，又陆续支持Word、Excel、PDF、Html、Xml、Json、MarkDown等文档格式的导出。

同时支持SqlServer、MySql、PostgreSQL、SQLite等多种数据库的文档查询和导出功能。​

开源地址

Gitee：https://gitee.com/izhaofu/SmartSQL

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

本项目力求做最方便、快捷的数据库文档查询生成工具！

二、数据库支持

• SqlServer
• MySQL
• PostgreSQL
• SQLite
• Oracle
• DB2
• TIDB
• 达梦
• 人大金仓

三、主要功能

3.1、文档的内容都包含什么？

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

3.2、支持导出哪些文档格式？

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

通过 文件➡导入备注，选择文件导入进行更新批注(注释)：

• pdm 由PowerDesigner设计数据库时产生。

• xml 由Visual Studio设置 实体类库的项目属性，勾选 XML文档文件 后生成项目时产生。

• xml 由SmartSQL的 XML导出 而产生。

四、工具截图

4.1、数据库连接

4.2、分组管理

在此可以对数据库中的表、视图、存储过程等对象实现自定义分组，方便后续管理

同时还支持对分组进行排序，将鼠标放在需要排序的分组上，当鼠标箭头变成➕就可以进行拖动排序了

对常用的分组可以置为默认展开，不常用的分组置为默认不展开，保持左侧菜单界面干净、清爽

4.3、快捷查询

4.4、导入导出

4.5、设置/关于

五、文档截图

5.1、CHM文档

5.2、HTML文档

六、常见问题

• 连接不上，怎么办？

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系统的区域设置，勾选了；取消勾选后，可能不存在该问题。

• 其他问题

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

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