# SmartSQL **Repository Path**: AutoProject/SmartSQL ## Basic Information - **Project Name**: SmartSQL - **Description**: 🔥🔥🔥 一款方便、快捷的数据库文档查询、生成工具，支持SqlServer/MySql/PostgreSQL/SQLite数据库表结构文档查询、生成；导出文档支持CHM、Word、Excel、PDF、Html、Xml、Json、MarkDown等多种格式。 - **Primary Language**: C# - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://gitee.com/izhaofu/SmartSQL - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 755 - **Created**: 2022-08-01 - **Last Updated**: 2022-08-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
SmartSQL

SmartSQL
⚡一款方便、快捷的数据库文档查询、生成工具

visual studio 2019 csharp license release

![首页](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/TopContent.png) ### 🚩 一、项目介绍 SmartSQL 是一款方便、快捷的数据库文档查询、导出工具！该工具从最初支持`CHM`文档格式开始，通过不断地探索开发、集思广益和不断改进，又陆续支持`Word`、`Excel`、`PDF`、`Html`、`Xml`、`Json`、`MarkDown`等文档格式的导出。同时支持`SqlServer`、`MySql`、`PostgreSQL`、`SQLite`等多种数据库的文档查询和导出功能。 ## 特别声明 SmartSQL 项目已加入 [dotNET China](https://gitee.com/dotnetchina) 组织。
![dotnetchina](https://gitee.com/dotnetchina/home/raw/master/assets/dotnetchina-raw.png "dotNET China LOGO") ##### 🏅开源地址 [![Gitee](https://shields.io/badge/Gitee-https://gitee.com/izhaofu/SmartSQL-green?logo=gitee&style=flat&logoColor=red)](https://gitee.com/izhaofu/SmartSQL)
[![GitHub](https://shields.io/badge/GitHub-https%3A%2F%2Fgithub.com%2FTeslaFly01%2FSmartSqlT-green?logo=github&style=flat)](https://github.com/TeslaFly01/SmartSqlT) > 🚀 本项目力求做最方便、快捷的数据库文档查询生成工具！ ### 🥝 二、数据库支持 - ✅ SqlServer - ✅ MySQL - ✅ PostgreSQL - ✅ SQLite - - [x] Oracle - - [x] DB2 - - [x] TIDB - - [x] 达梦 - - [x] 人大金仓 ### 📖 三、主要功能 #### 1.文档的内容都包含什么？ - `表` 序号 | 列名 | 主键 | 自增 | 数据类型 | 长度 | 允许NULL值 | 默认值 | 备注说明 - `视图` 视图内容SQL脚本 - `存储过程` 存储过程内容SQL脚本 #### 2.支持导出哪些文档格式？ ![CHM文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/chm.png) | ![Excel文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/excel.png) | ![Word文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/word.png) | ![PDF文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/pdf.png) --|--|--|-- ![Html文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/html.png) | ![Xml文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/xml.png) | ![Json](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/json.png) | ![MarkDown](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/icon/markdown.png) #### 3.更新表列的注释，有哪些方式？ - 通过 `文件`➡`导入备注`，选择文件导入进行更新批注(注释)： - [x] pdm 由`PowerDesigner`设计数据库时产生。 - [x] xml 由`Visual Studio`设置 实体类库的项目属性，勾选 XML文档文件 后生成项目时产生。 - [x] xml 由`SmartSQL`的 XML导出 而产生。 ### 🎉 四、工具截图 #### 1.数据库连接 ![数据库连接](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-ConnectType.png)|![数据库连接](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Connect.png) --|-- > 连接管理里面可以对当前添加的连接进行`添加`、`删除`和`修改`等操作。 > 目前支持对`SQLServer`、`MySQL`、`PostgreSQL`、`SQLite`等4种数据库的支持。 > 对`Oracle`、`DB2`、`TIDB`、`达梦`等其他关系型数据库的支持也正在紧张进行中。 #### 2.分组管理 ![分组管理](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Group.png)|![分组管理](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-GroupObject.png) --|-- > 在此可以对数据库中的`表`、`视图`、`存储过程`等对象实现自定义分组，方便后续管理 > 同时还支持对分组进行排序，将鼠标放在需要排序的分组上，当鼠标箭头变成➕就可以进行拖动排序了 > 对`常用的分组`可以置为默认`展开`，`不常用的分组`置为默认`不展开`，保持左侧菜单界面干净、清爽 #### 3.快捷查询 | ![快捷查询](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Objects.png) | ![快捷查询](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-View.png) | |--|--| | ![快捷查询](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Proc.png) | ![快捷查询](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Column.png) | #### 4.导入导出 ![导入备注](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Import.png)|![导出文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Export.png) :--:|:--: #### 5.设置/关于 ![设置](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-Setting.png) | ![关于](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/sshot-About.png) --|-- ### 🎉 五、文档截图 #### 1.CHM文档 ![CHM文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/chm.png)|![CHM文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/chmd.png) |--|--| #### 2.HTML文档 ![HTML文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/html.png)|![HTML文档](https://gitee.com/izhaofu/SmartSQL/raw/master/Img/docImg/htmlt.png) |--|--| ### ⬇️ 六、下载地址 [![立即下载](https://img.shields.io/badge/%E7%AB%8B%E5%8D%B3%E4%B8%8B%E8%BD%BD----green)](https://gitee.com/izhaofu/SmartSQL/releases) 下载解压后，双击运行 `SmartSQL.exe`。 ### 🔥七、沟通交流
### ⚡ 附一、近期计划 ✅ 收集问题，修复完善基础功能 ✅ C#实体代码生成 ⏳ 计划中：对象结构对比功能 ⏳ 计划中：表、视图、存储过程同步功能 ⏳ ... ### ❓ 附二、常见问题 - **连接不上，怎么办？** > 1. `连接数据库`界面填写的`连接信息`真的正确无误? > 2. `数据库服务器`有`防火墙/安全组`限制？ > 3. 用 [Navicat Premium](https://gitee.com/dotnetchina/DBCHM/attach_files) 连接数据库服务器试试！ - **连接数据库时，点了 `连接/测试` ，半天没响应？** > 可能是连接远程数据库网络不好的原因，可以把`连接超时`设置的小一些。 - **SmartSQL可以连接上，但显示不了数据怎么办？** > - 导出文档前，数据库使用账号要给予`root级别`的权限，非root级别账号连接，可能会出现`表数据显示不全`或数据查询因权限不足，会`查不出来数据`！ > - SmartSQL有Bug， [提Issue](https://gitee.com/izhaofu/SmartSQL/issues/new) 反馈。 - **表列的批注数据我想迁移，怎么办？** > 1. 使用 SmartSQL 的 `XML导出`，对当前数据库的批注数据 就会导出一个xml文件。 > 2. 点`数据连接`， 切换至 目标数据库连 > 3. 再用`批注上载` 就可以选择刚刚的xml文件，如果数据库表结构相同，批注就会更新到目标数据库服上。 - **数据库比较老，如 `Sql Server 2000 `，怎么使用SmartSQL？** > 1. 下载安装 [Navicat Premium](https://gitee.com/dotnetchina/DBCHM/attach_files) > 2. 连接上老旧的数据库服务器，将数据库表结构脚本导出。 > 3. 找一台高版本的数据库服务器，新建一个临时数据库，将导出的脚本导入。 > 4. 然后用SmartSQL连接高版本的数据库服务器。 - **chm文件可以正常导出，但是文件名中文乱码，打开显示 无法访问此页** > 这种情况，有一种可能是win系统的**区域设置**，勾选了；取消勾选后，可能不存在该问题。 - **其他问题** > 如遇其他问题，可以通过Issues反馈，记录问题，请写清楚遇到问题的原因、软件版本、系统环境、数据库版本、甚至数据库结构、复现步骤以及期望达到的效果；建议配上多张全屏大图，请勿使用局部截屏小图！方便我们这边可以迅速定位，解决问题。 > PS：如果你有更好方法，欢迎提供改善建议，助力✊该工具越来越好使！