README_CN.md

12.26.2.mov

Chat2DB 是一个智能的通用SQL客户端和数据报表工具，它集成了AI的能力。Chat2DB可以帮助您更快地编写SQL查询、管理数据库、生成报告、探索数据、并且可以与多种数据库进行交互。Chat2DB是一个开源项目，我们欢迎您的贡献。

1. 智能生成SQL: Chat2DB Pro支持AI驱动的智能SQL开发，可以帮助您更快地编写SQL查询。

2. 数据库管理: 支持多种10+数据库，包括MySQL、PostgreSQL、H2、Oracle、SQLServer、SQLite、MariaDB、ClickHouse、DM、Presto、DB2、OceanBase、Hive、KingBase、MongoDB、Redis、Snowflake等。

3. 智能生成报表: Chat2DB Pro支持AI驱动的智能数据报表，可以帮助您更快地生成看板。

4. 数据结构同步: Chat2DB Pro支持数据库表结构同步，可以帮助您更快地同步数据库表结构。

功能比较

功能	社区开源版	Local版(收费)	Pro版(收费)
数据库类型	16+	目标100+	目标100+
支持的 AI	需要配置AI	安装即可使用AI	安装即可使用AI
AI 能力	简单	多样	多样
可视化编辑表	✅	✅	✅
SQL控制台	✅	✅	✅
SQL格式化	✅	✅	✅
保存查询记录	✅	✅	✅
主题颜色设置	✅	✅	✅
数据结构同步	❌	✅	✅
数据库分组	❌	✅	✅
数据库结构导入导出	❌	✅	✅
数据导入导出	❌	✅	✅
数据迁移	❌	✅	✅
复制/清空表	❌	✅	✅
打开运行SQL文件	❌	✅	✅
UML图	❌	开发中	开发中
生成代码	❌	✅	✅
复制结果为 Insert/update	❌	✅	✅
修改查询结果	❌	✅	✅
智能SQL编辑器	❌	✅	✅
AI建表	❌	✅	✅
AI数据集	❌	✅	✅
Chat2Excel	❌	✅	✅
智能看板	❌	✅	✅
编辑器设置	❌	✅	✅
自定义快捷键	❌	✅	✅
跨多设备使用	❌	❌	✅

下载安装

Chat2DB 是一个跨平台的应用程序，支持Windows、MacOS和Linux。您可以从以下链接下载Chat2DB。

• 下载 Pro 版
• 下载 Local 版
• 下载开源版

社区版 Docker 安装

系统要求

在安装 Chat2DB 之前，请确保您的系统满足以下要求：

• Docker 19.03.0 或更高版本
• Docker Compose 1.25.0 或更高版本
• CPU >= 2 Core
• RAM >= 4 GiB

  // 拉取最新客户端,然后运行docker,名字是 `chat2db` , 并且将 `/root/.chat2db` 挂载到 `~/.chat2db-docker`
  docker run --name=chat2db -ti -p 10824:10824 -v ~/.chat2db-docker:/root/.chat2db  chat2db/chat2db:latest
  // 这里正常会提示`Tomcat started on port(s): 10824 (http) with context path` 就可以结束了

  // 如果这里提示  `The container name "/chat2db" is already in use by container`, 代表已经存在容器了 运行
  docker start chat2db
  // 如果想更新chat2db 则需要先rm
  docker rm chat2db

代码调试

运行环境

注意： 如果需要本地调试

• java 运行 Open JDK 17
• Node 运行环境 Node16 Node.js.

git clone 到本地

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

前端调试

node版本必须为16及以上 
一定要用yarn
$ cd Chat2DB/chat2db-client
$ yarn
$ yarn run start:web

后端调试

$ cd ../chat2db-server
$ mvn clean install # 需要安装maven 3.8以上版本
$ 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功能

独立部署

# 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

# 再打包后端服务

联系我们

• Email: [email protected]
• Discord: Join our Discord server
• Twitter: @Chat2DB
• YouTube: Chat2DB Channel
• GitHub: Chat2DB GitHub

致谢

感谢所有为 Chat2DB 贡献力量的同学们~~

Star History

License

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