---
name: Chat2DB
summary: "Chat2DB is an open-source Java project with 25.7k GitHub stars. It is associated with ai, bi, chatgpt, clickhouse. The repository is actively maintained, with recent commits."
language: Java
license: Apache-2.0
repo: https://github.com/OtterMind/Chat2DB
source: https://opensources.dev/resource/chat2db
health: 100
---

# Chat2DB

Chat2DB is an open-source Java project with 25.7k GitHub stars. It is associated with ai, bi, chatgpt, clickhouse. The repository is actively maintained, with recent commits.

**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

## Download and Installation

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

- [Download Pro Version](https://chat2db.ai/download)
- [Download Open Source Version](https://github.com/CodePhiliaX/Chat2DB/releases/tag/v0.3.6)

## 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

```bash
  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:

- Java runtime: Open JDK 17
- Node.js runtime: Node 16 Node.js.

**Clone the repository locally**

```bash
$ git clone git@github.com:chat2db/Chat2DB.git
```

**Frontend Debugging**

```bash
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**

```bash
$ 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**

```bash
# 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](./CONTRIBUTING.md). 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](https://github.com/CodePhiliaX/Chat2DB/issues).
- For questions, setup help, and open-ended discussions, please use [GitHub Discussions](https://github.com/CodePhiliaX/Chat2DB/discussions).
- If your pull request is related to an issue, please link it in the PR description.

## Contact Us

- Email: [Chat2DB@ch2db.com](mailto:Chat2DB@ch2db.com)
- Discord: [Join our Discord server](https://discord.gg/JDkwB6JS8A)
- Twitter: [@Chat2DB](https://x.com/Chat2DB_AI)
- YouTube: [Chat2DB Channel](https://www.youtube.com/@chat2db.tutorial)
- GitHub: [Chat2DB GitHub](https://github.com/codePhiliaX/chat2db)

## Acknowledgments

Thanks to everyone who has contributed to Chat2DB~~

## Star History

## License

The primary license used by this software is the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), supplemented by the [Chat2DB License](./Chat2DB_LICENSE).