Skip to content

SherlockSoftwareInc/SQL-Document-Builder

Repository files navigation

SQL Document Builder

SQL Document Builder is a desktop IDE and documentation tool in the Octofy Ecosystem. It helps teams script database objects, generate technical documentation, and enrich schema metadata with AI.

Its primary goal is to turn raw schema objects into clear, context-rich documentation that improves both developer productivity and AI-driven SQL workflows.

The application now supports multiple DBMS platforms:

  • SQL Server
  • Oracle
  • PostgreSQL
  • MySQL/MariaDB

🚀 Key Features

🧠 AI-Powered Documentation & Development

  • Auto-Generated Descriptions – Generate or refine descriptions for tables, views, and columns using built-in AI.
  • Describe Missing – Fill only undocumented fields while preserving existing descriptions.
  • Describe with Context – Provide custom prompts/instructions to guide AI output.
  • Batch Describe – Process multiple objects in sequence with progress feedback.
  • AI Script Optimization – Improve SQL scripts for readability and maintainability.
  • Natural Language Refactoring – Request SQL changes in plain language.

🔌 Multi-DBMS Connection Management

  • Add, edit, and remove database connections.
  • Save connections and restore the last active session.
  • Switch quickly between active connections.
  • Work across Oracle, PostgreSQL, and MySQL environments.

🗂️ SQL Editing Experience

  • Multi-tab editor for parallel script work.
  • Rename/organize tabs and reopen recent files quickly.
  • Built-in find/replace with improved replace-all behavior.

🔍 Object Browsing

  • Browse common database objects (tables, views, procedures/functions, and related objects).
  • Filter by schema and search by name.
  • Select multiple objects for bulk operations.

📝 Script & Documentation Generation

  • Generate structure scripts and related SQL output.
  • Export metadata and descriptions.
  • Produce Markdown/JSON documentation with templates.
  • Save table and column descriptions back to the database.

📄 Template-Based Output

  • Flexible documentation output using templates.
  • Supports Markdown, HTML, Wiki/SharePoint-style formats, and custom layouts.

📋 Import/Export and Clipboard Integration

  • Import from Excel or clipboard.
  • Export descriptions to formatted files.
  • Open/save SQL, Markdown, HTML, and text files.
  • Automatic HTML-to-Markdown conversion when pasting into Markdown editors.

⚡ Execution, Validation, and Usability

  • Execute full scripts or selected statements.
  • Validate SQL before execution.
  • Safety confirmations for destructive operations.
  • Dark mode, status/progress feedback, and configurable editor behavior.

🛠️ Extensibility

SQL Document Builder is designed for growth. New output formats and custom documentation styles can be introduced through templates.


📸 Screenshots

🖥️ Main Interface

Main Interface

📂 Markdown Output

Markdown Document Output

📝 Template Editor

Template Editor


📦 Installation

SQL Document Builder is distributed via a ClickOnce installer.

👉 Click here to install

After installation, the app is available from the Start Menu and updates automatically.

About

Build scripts and docs with ease. This tool features multi-tab SQL editing and built-in AI to instantly generate table and column descriptions. Export to Markdown or SharePoint while maintaining high-quality metadata for better data insights.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages