Hello everyone, I'm Wolf at the End of the Desert.
1. Project Introduction
Today, I'd like to introduce an open-source .NET project named SmartSQL. The site owner came across it through a public account article shared by Zhang team: Open Source: A Powerful and Versatile Toolbox Based on .NET to Boost Development Efficiency. After reviewing the project's source code today, I find it highly worth a second recommendation. This article will introduce it from two aspects: source code and features.
About this open-source project:
- Repository URL: https://gitee.com/dotnetchina/SmartSQL
- License: Apache-2.0
- Project Goal: A convenient and quick tool for querying and generating database documentation, aiming to become a metadata management tool that helps enterprises rapidly achieve digital transformation.
2. Brief Analysis of Source Code
The source code includes three projects: SmartSQL, SmartSQL.DocUtils, and SmartSQL.Framework. Let's quickly go through them. If you're interested in the source code, feel free to pull it and take a look!
2.1. SmartSQL
This is the main project, a WPF project that uses third-party libraries such as AduSkin, AvalonEdit, HandyControl, and FontAwesome.WPF. Through this project, you can learn how to use third-party control libraries and font libraries. Later, you can see the practical effects of the control libraries in the tool screenshots.
Additionally, as shown in the code file screenshot above, the specific implementations of each tool are also in this project. If you have related functional requirements during daily work, you can directly reference this project. Here's a list of tools:
2.2. SmartSQL.DocUtils
This project is a class library that encapsulates the import and export of various data files. From the repository description, you'll know how rich the file support is:
SmartSQL is a convenient and quick tool for querying and exporting database documentation! Initially only supporting SQL Server databases and CHM document formats, through continuous exploration, development, brainstorming, and iterative improvement, it has successively supported export to Word, Excel, PDF, HTML, XML, JSON, Markdown, and other document formats. At the same time, it has expanded to support querying and exporting database documentation for multiple databases including SQL Server, MySQL, PostgreSQL, and SQLite.
2.3. SmartSQL.Framework
As the name suggests, this class library is the core project, implementing the core code for querying and exporting database documentation. If you're interested in database operations, feel free to check it out.
3. Feature Showcase
Set the SmartSQL project as the startup project and click Run (or download the installer to run):
Below are some feature screenshots (mostly from the repository README). For detailed features, please refer to the repository for real-time updates.
3.1. Feature Architecture
3.2. Dashboard
3.3. Quick Query
3.4. Import and Export
3.5. Document Screenshots
CHM Document
HTML Document
Word Document
Excel Document
PDF Document
3.6. Toolbox List
Recorded usage of three tools:
QR Code Generation
Feel free to scan the QR code to try it.
JSON Formatting
Chinese to Pinyin
For more tools, please compile the source code or download to experience.
4. Conclusion
Finally, here again is the repository URL: https://gitee.com/dotnetchina/SmartSQL.
We hope this tool brings you convenience and its source code provides you with reference.