1. Project Overview

SmartSQL

⚡ A Convenient and Efficient Database Documentation Query and Generation Tool

Dedicated to becoming a metadata management tool that helps enterprises achieve digital transformation quickly.

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

Function Demonstration

Dashbord

Toolbox

Website Navigation

Database Connections

In Connection Management, you can perform the following operations on existing connections:Add、ModifyandDeleteand other operations.

Currently supports the following six database types:SQLServer、MySQL、Oracle、PostgreSQL、DM... and 6 other supported database types.

Support for other relational databases such asDB2、TIDB、HighGois currently under development.

Group Management

Here you can manage the following database objects:Tables、Views、Stored ProceduresCreate custom groups for easier management.

Group sorting is also supported. Place the mouse over the group you want to sort. When the cursor changes to ➕, you can drag and drop to reorder it.

Support for other relational databases such asFrequently Used GroupsCan be set as defaultExpand，Infrequently Used GroupsSet as defaultDo not expand

Import and Export

Supports exportingTables、Views、Stored Proceduresinto offline documents in multiple formats.

Supports exportingXMLSupports importing documents in the following formats.Tables、Columns、Views、Stored ProceduresComments

Settings / About

Supports configuring prefix-based fuzzy search and full-text fuzzy search when searching.

Supports configuring the right-side main interface to use either multiple tabs or a single tab.

📰 Documentation Screenshots

CHM Documentation

HTML Documentation

Word Documentation

Excel Documentation

PDF Documentation

4. Feature Overview

This project aims to provide the most convenient and efficient database documentation query and generation tool!

5. Tech Stack

A convenient and efficient database documentation query and generation tool that supports querying and generating database table structure documentation for SqlServer/Oracle/MySql/PostgreSQL/SQLite. Export formats include CHM, Word, Excel, PDF, Html, Xml, Json, MarkDown, and more.

Architecture

⚡ Upcoming Plans

✅ Collect feedback, fix issues, and improve core functionality
✅ C# entity code generation
⏳ In Progress: Fix bugs reported in existing Issues
⏳ Planned: Support for DB2, TIDB, Dameng, and other databases
⏳ Planned: Object structure comparison
⏳ Planned: Synchronization of tables, views, and stored procedures
⏳ ...