Skip to content

README.md

Latest commit

 

History

History
222 lines (159 loc) · 5.56 KB

README.md

File metadata and controls

222 lines (159 loc) · 5.56 KB

QueryExe

Universal Database Management Tool

A powerful, modern database editor built with JavaFX that brings professional database management capabilities to your desktop.

Java Version JavaFX License

Features • Supported Databases • Installation • Usage • Building

✨ Features

🔌 Multi-Database Support

Connect to and manage multiple database systems simultaneously:

  • MySQL - World's most popular open source database
  • MariaDB - Enhanced MySQL fork with advanced features
  • PostgreSQL - Advanced open source relational database
  • SQL Server - Microsoft's enterprise database platform
  • H2 - Fast, lightweight embedded database
  • SQLite - Self-contained, serverless database engine

⚡ Core Capabilities

Connection Management

  • Manage multiple database connections simultaneously
  • Active concurrent connection monitoring
  • Custom JDBC driver configuration

Query Execution

  • Run multiple queries concurrently
  • Advanced SQL editor with syntax highlighting
  • Intelligent SQL code suggestions and autocomplete
  • Save and organize SQL queries for reuse

Schema Management

  • Browse and navigate databases, schemas, tables, and columns
  • View detailed table and column properties
  • Create, modify, and delete tables
  • Create and drop databases/schemas

Data Manipulation

  • Edit result sets directly in the grid
  • Generate DDL scripts automatically
  • Create INSERT scripts from data
  • Export data in multiple formats:
    • CSV
    • JSON
    • XML

Developer Experience

  • Modern, intuitive JavaFX interface
  • Syntax highlighting for SQL code
  • Intelligent code completion
  • Fast and responsive UI
  • Cross-platform compatibility

🗄️ Supported Databases

Database Pre-installed Driver Version
MySQL 9.5.0
MariaDB 3.5.6
PostgreSQL 42.7.8
SQL Server 13.2.1.jre11
H2 2.4.240
SQLite 3.51.1.0

All JDBC drivers can be customized by the user to support different versions or configurations.

🚀 Installation

Prerequisites

  • Java 21 or higher
  • Maven 3.6+ (for building from source)

Download

Download the latest release from the Releases page.

Run

java -jar queryexe-1.0.0.jar

💻 Usage

Creating a Connection

  1. Click the New Connection button
  2. Select your database type
  3. Enter connection details (host, port, database, credentials)
  4. Test the connection
  5. Save and connect

Running Queries

  1. Open a new query tab
  2. Write your SQL query with syntax highlighting and autocomplete
  3. Execute with Ctrl+Enter or click the Run button
  4. View results in the data grid
  5. Edit cells directly or export results

Managing Tables

  • Right-click on any table to access table operations
  • Create Table: Define columns, types, and constraints
  • Alter Table: Modify structure and properties
  • Drop Table: Remove tables with confirmation
  • View Properties: Inspect table metadata and statistics

Exporting Data

  1. Execute a query to generate a result set
  2. Click Export
  3. Choose format (CSV, JSON, or XML)
  4. Select destination and export

🛠️ Building from Source

Clone the Repository

git clone https://github.com/B077AS/query-exe
cd query-exe

Build with Maven

# Build with platform-specific JavaFX dependencies
mvn clean package -Ppackage

Run from Source

mvn javafx:run

The compiled JAR will be available in the target/ directory.

🏗️ Technology Stack

  • Java 21 - Modern LTS Java version
  • JavaFX 22 - Rich desktop UI framework
  • AtlantaFX - Modern JavaFX theme
  • RichTextFX - Advanced text editing component
  • JDBC Drivers - Native database connectivity
  • Maven - Build and dependency management
  • Lombok - Boilerplate reduction

🎨 Screenshots

Overall Design

Overall Design

Table Options

Table Options

Connection Creation

Connection Creation

Editor Features

Editor Features

📋 Roadmap

  • ER diagram generation
  • Theme selection
  • Query performance analysis
  • Database backup and restore

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License

🙏 Acknowledgments

Made with Java

If you find QueryExe useful, consider giving it a ⭐!