README.md

June 17, 2026 ยท View on GitHub

๐Ÿ“ฃ Exciting News from the Chat2DB Team! > We just open-sourced Nubase โ€” our brand new deployment layer for Artificial Intelligence-native applications! If Chat2DB helps you manage data effortlessly, Nubase will help you deploy your AI coding tools and agents with zero friction.

Show some love and give Nubase a โญ๏ธ on GitHub to support our open-source journey!

Chat2DB

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

OtterMind%2FChat2DB | Trendshift

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 git@github.com: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.