Skip to content

Latest commit

 

History

History
314 lines (270 loc) · 11.4 KB

README.md

File metadata and controls

314 lines (270 loc) · 11.4 KB
Raw
CodePhiliaX%2FChat2DB | Trendshift

chat on Discord Share on Telegram Share on Reddit

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

Chat2DB is an intelligent, universal SQL client and data reporting tool that integrates AI capabilities. Chat2DB helps you write SQL queries faster, manage databases, generate reports, explore data, and interact with multiple databases. Chat2DB is an open-source project, and we welcome your contributions.

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 Local Pro
Database Types 16+ Target 100+ Target 100+
Supported AI Requires AI Configuration AI ready on installation AI ready on installation
AI Capabilities Basic Varied 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 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

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.