Home
Softono

Chat2DB

Open source Apache-2.0 Java
25.7K
Stars
2.8K
Forks
534
Issues
154
Watchers
4 months
Last Commit

 About Chat2DB

AI-driven database tool and SQL client, The hottest GUI client, supporting MySQL, Oracle, PostgreSQL, DB2, SQL Server, DB2, SQLite, H2, ClickHouse, and more.

Platforms

Web Self-hosted

Languages

Java

Need Help Installing Chat2DB?

We provide expert installation service for this software. Our team will install, configure, and secure Chat2DB on your server. plans start at just $30.

Chat2DB

An AI-powered database client and SQL workspace for developers, DBAs, analysts, and data teams.

Modelscope ReadmeX Discord Twitter Telegram Whatsapp Reddit Gmail

README in English 简体中文版自述文件 日本語のREADME

1. Intelligent SQL Generation:
Chat2DB Pro supports AI-driven intelligent SQL development to help you write SQL queries faster.

2. Database Management:
Supports more than 10 databases, including MySQL, PostgreSQL, H2, Oracle, SQLServer, SQLite, MariaDB, ClickHouse, DM, Presto, DB2, OceanBase, Hive, KingBase, MongoDB, Redis, Snowflake, and more.

3. Intelligent Report Generation:
Chat2DB Pro supports AI-driven intelligent data reporting to help you generate dashboards faster.

4. Data Structure Synchronization:
Chat2DB Pro supports database table structure synchronization to help you sync database table structures faster.

Feature Comparison

Feature Community Open Source Pro
Database Types 16+ Target 100+
Supported AI Requires AI Configuration AI ready on installation
AI Capabilities Basic Varied
Visual Table Editor ✅ ✅
SQL Console ✅ ✅
SQL Formatting ✅ ✅
Save Query Records ✅ ✅
Theme Color Settings ✅ ✅
Data Structure Sync ❌ ✅
Database Grouping ❌ ✅
Database Structure Import/Export ❌ ✅
Data Import/Export ❌ ✅
Data Migration ❌ ✅
Copy/Clear Table ❌ ✅
Open and Run SQL Files ❌ ✅
UML Diagram ❌ In Development
Generate Code ❌ ✅
Copy Results as Insert/Update ❌ ✅
Modify Query Results ❌ ✅
Intelligent SQL Editor ❌ ✅
AI Table Creation ❌ ✅
AI Data Sets ❌ ✅
Chat2Excel ❌ ✅
Intelligent Dashboard ❌ ✅
Editor Settings ❌ ✅
Custom Shortcuts ❌ ✅
Cross-device Usage ❌ ✅

Download and Installation

Chat2DB is a cross-platform application that supports Windows, MacOS, and Linux. You can download Chat2DB from the following links:

Community Edition Docker Installation

System Requirements

Before installing Chat2DB, ensure your system meets the following requirements:

  • Docker 19.03.0 or later
  • Docker Compose 1.25.0 or later
  • CPU >= 2 Cores
  • RAM >= 4 GiB
  docker rm chat2db
  
  docker run --name=chat2db -ti -p 10824:10824 -v ~/.chat2db-docker:/root/.chat2db  chat2db/chat2db:latest

  docker start chat2db
  

Code Debugging

Runtime Environment

Note: If local debugging is needed:

Clone the repository locally

$ git clone [email protected]:chat2db/Chat2DB.git

Frontend Debugging

Node version must be 16 or higher  
Use yarn only, npm is not supported
$ cd Chat2DB/chat2db-client
$ yarn
$ yarn run start:web

Backend Debugging

$ cd ../chat2db-server
$ mvn clean install # Maven version 3.8 or higher is required
$ cd chat2db-server/chat2db-server-start/target/
$ java -jar -Dloader.path=./lib -Dchatgpt.apiKey=xxxxx chat2db-server-start.jar  # 需要安装java 17以上版本,启动应用 chatgpt.apiKey 需要输入ChatGPT的key,如果不输入无法使用AIGC功能

Standalone Deployment

# chat2db-client
$ npm run build:web:prod 
$ cp -r dist ../chat2db-server/chat2db-server-start/src/main/resources/static/front 
$ cp -r dist/index.html ../chat2db-server/chat2db-server-start/src/main/resources/thymeleaf

Contributing

We welcome bug reports, feature requests, documentation improvements, testing feedback, and pull requests from the community.

Before opening an issue or submitting a pull request, please read our Contributing Guide. It explains how to report bugs, suggest improvements, and make contributions easier for maintainers to review.

  • For bugs and feature requests, please use GitHub Issues.
  • For questions, setup help, and open-ended discussions, please use GitHub Discussions.
  • If your pull request is related to an issue, please link it in the PR description.

Contact Us

Acknowledgments

Thanks to everyone who has contributed to Chat2DB~~

Star History

Star History Chart

License

The primary license used by this software is the Apache License 2.0, supplemented by the Chat2DB License.