Skip to content

Commit

Permalink
merge
Browse files Browse the repository at this point in the history
  • Loading branch information
shanhexi committed Mar 18, 2024
2 parents 96bda51 + 524abce commit c573b34
Show file tree
Hide file tree
Showing 49 changed files with 329 additions and 12 deletions.
2 changes: 1 addition & 1 deletion next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ module.exports = withNextra({
return [
{
source: "/",
destination: "/docs",
destination: "/docs/start-guide/getting-started",
statusCode: 301,
},
];
Expand Down
28 changes: 28 additions & 0 deletions pages/_meta.ja-JP.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"*": {
"theme": {
"footer": false
}
},
"index": {
"title": "Introduction",
"type": "page",
"display": "hidden"
},
"docs": {
"title": "文档",
"type": "page"
},
"blog": {
"title": "博客",
"type": "page"
},
"changelog": {
"title": "更新记录",
"type": "page"
},
"contact": {
"title": "联系我们",
"type": "page"
}
}
28 changes: 28 additions & 0 deletions pages/_meta.tr-TR.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"*": {
"theme": {
"footer": false
}
},
"index": {
"title": "Introduction",
"type": "page",
"display": "hidden"
},
"docs": {
"title": "文档",
"type": "page"
},
"blog": {
"title": "博客",
"type": "page"
},
"changelog": {
"title": "更新记录",
"type": "page"
},
"contact": {
"title": "联系我们",
"type": "page"
}
}
28 changes: 28 additions & 0 deletions pages/_meta.zh-TW.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"*": {
"theme": {
"footer": false
}
},
"index": {
"title": "Introduction",
"type": "page",
"display": "hidden"
},
"docs": {
"title": "文档",
"type": "page"
},
"blog": {
"title": "博客",
"type": "page"
},
"changelog": {
"title": "更新记录",
"type": "page"
},
"contact": {
"title": "联系我们",
"type": "page"
}
}
7 changes: 4 additions & 3 deletions pages/docs/_meta.en-US.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"getting-started": "Getting Started",
"second": "Second",
"ai": "AI"
"start-guide": "Start Guide",
"ai": "AI",
"contact_us":"Contact Us"

}
4 changes: 4 additions & 0 deletions pages/docs/_meta.ja-JP.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"start-guide": "快速开始",
"ai": "人工智能"
}
7 changes: 4 additions & 3 deletions pages/docs/_meta.zh-CN.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"getting-started": "快速开始",
"second": "第二篇",
"ai": "人工智能"
"start-guide": "入门",
"ai": "AI",
"contact-us":"联系我们"

}
3 changes: 2 additions & 1 deletion pages/docs/ai/_meta.en-US.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"ai-start": "Quick Start"
"ai-set":"Set AI",
"ai-use":"Use AI"
}
3 changes: 2 additions & 1 deletion pages/docs/ai/_meta.zh-CN.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"ai-start": "快速开始"
"ai-set":"配置AI",
"ai-use":"使用AI"
}
35 changes: 35 additions & 0 deletions pages/docs/ai/ai-set.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# AI配置

## 方法一:✅ 通过 Chat2DB AI 使用 AI 能力(推荐)
直接使用AI功能,系统会弹出公众号二维码,扫码关注即可使用,系统会自动导入Chat2DB AI 的ApiKey。
<br/><br/>



## 方法二:⚠ 通过 Open AI key使用AI能力
#### 操作方法
设置--> 自定义AI --> Open AI -->填写数据 --> 点击“应用”按钮

> ⚠ 提示:使用 OpenAI Key 是客户端直接请求 OpenAI 的接口 ,Chat2DB 没有对使用 OpenAI 做任何限制,有异议直接看代码。
> 如果使用 OpenAI 遇到的错误 95% 都是 Open AI 限制导致的,Open AI 限制如下:
>
> 1、访问 OpenAI 需要能够科学上网,并且能够开启全局代理,很多科学上网不支持全局代理导致不可用。
> 2、大部分人都是通过某宝,或者其他平台买了一个 Key 用来访问 OpenAI,这些Key都是共享的,OpenAI 对 Key 有限制,
> 如果某个 Key 被多人使用,Open AI会限制该Key的使用,导致使用不了。
>
> Open AI官方限制文档:https://platform.openai.com/docs/guides/rate-limits/overview
<br/>

#### 常见问题
**Q:为什么我科学上网了openai还是用不了?**
A:如果网页gpt可以正常聊天,说明你的VPN只对浏览器生效了,不是全局的,并没有对部分Java应用生效,
在chat2db客户端中手动配置代理即可。
> 需要配置:
> HTTP Proxy Host 一般为127.0.0.1
> HTTP Proxy Port VPN软件代理的本地端口号 小猫咪为7890
> Api Host 如果你直接用的openai的服务没有做中间代理那么不需要填写
<br/>
## 方法三:其他AI模型
目前支持的AI模型:Chat2DB, 智谱, 百川, 文心一言, Open AI, Azure AI。
26 changes: 26 additions & 0 deletions pages/docs/ai/ai-use.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 使用AI

## 自然语言生成sql

右侧点击选择表后,在输入框中输入您想要执行的操作,回车,AI会自动生成sql语句
!['sql'](public\image\AI-image\AI-generateSQL.png)

## SQL翻译为自然语言
有的时候我们会遇到非常复杂的SQL,有的甚至成百上千行的SQL,
要读懂这段SQL可能需要几个小时甚至几天时间。我们通过Chat2DB也可以快速的了解这段SQL的含义。

使用方法:选中sql语句->右键->解释sql
!['sql'](public\image\AI-image\AI-sql.png)

## sql性能优化
有的时候我们写了一段SQL性能不好,Chat2DB也可以帮我们优化SQL,提升查询性能。

使用方法:选中sql语句->右键->优化sql



## sql语法转换
不同数据库SQL语法间有略微的差异,我们也可以通过Chat2DB让他帮我们去转换这个SQL的语法。

使用方法:选中sql语句->右键->转化sql,在如下的页面选择要转化的数据库。
!['sql-convert'](public\image\AI-image\sql-convert.png)
File renamed without changes.
1 change: 1 addition & 0 deletions pages/docs/contact-us.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 联系我们
1 change: 0 additions & 1 deletion pages/docs/second.en-US.mdx

This file was deleted.

1 change: 0 additions & 1 deletion pages/docs/second.zh-CN.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions pages/docs/start-guide/_meta.en-US.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"getting-started":"Getting Started",
"download":"DownLoad",
"tutorial":"Tutorial",
"generate-chart":"Generate Chart"
}
7 changes: 7 additions & 0 deletions pages/docs/start-guide/_meta.zh-CN.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"getting-started": "快速入门",
"download":"下载和安装",
"database-connection":"一.数据库连接",
"database-management":"二.数据库管理",
"generate-chart":"三.数据报表"
}
File renamed without changes.
50 changes: 50 additions & 0 deletions pages/docs/start-guide/database-connection.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 教程

## 数据库连接
#### 选择数据库类型
点击左侧选择“数据源”图标,进入数据库连接界面,用户可在右侧面板中选择数据库类型。

!['P-database'](/image/tutorial-image/picture1.PNG) <br/><br/>

#### 配置数据库信息
填写数据库信息-->下载驱动-->点击“测试连接”按钮。


!['P-database'](public\image\tutorial-image\connect-database2.png)
若测试链接成功,点击保存完成数据库连接;
连接失败请往下翻。
<br/><br/>

### 数据库连接问题
#### 检查数据库信息
主机:填写数据库所在的ip地址。(!注意:若数据库在本电脑docker上启动,ip地址需要填本机的地址,不要填localhost。)
身份验证:选User&Password
用户名和密码请仔细检查!
数据库:可不填
url:根据所填信息自动生成
驱动:请检查版本是否兼容
SSH:可选
高级配置:可选

#### 驱动配置
链接数据库需要下载对应的驱动,如果驱动为空有两种方式配置驱动
1、如果可以链接公网,点击“下载驱动”按钮,下载驱动,然后点击选择驱动。
2、如果无法连接公网或者默认驱动不能适配你的数据库,可以在本地下载驱动,
点击“上传驱动”按钮,选择驱动文件上传,上传成功后即可使用。

<img src="/image/tutorial-image/driver.png" width="80%" /> <br/>
<img src="/image/tutorial-image/driver2.png" width="60%" /> <br/><br/>

#### 配置SSH(可选)
如果数据库需要通过SSH隧道连接,可以选择使用SSH true 配置SSH隧道信息。
(注意:用户名填服务器的用户名,而非数据库)

<img src="/image/tutorial-image/ssh.png" width="80%" />


### ⚠ 错误提示
&emsp; 如果连接失败,会有错误提示,可以根据错误提示进行排查,99%以上的问题都是都是配置错误,
或者驱动版本不适配你的数据库版本,网上查询大部分都能解决。

&emsp; 如果仍然无法解决,查看详情后可以复制错误信息,在 GitHub 提交 issue,所有 issue 我们都会去看,
提交 issue 是最有效的解决办法。
Empty file.
38 changes: 38 additions & 0 deletions pages/docs/start-guide/database-management.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 教程

## 数据库管理

**进入工作台界面,用户可在此查看和管理数据库**
与传统数据库管理软件不同的是,Chat2DB提供了丰富的AI功能。除了能实现自然语言转sql之外,还有解释
sql语句、优化sql等等,详细说明请参考[AI功能](/zh-CN/docs/ai/ai-use#使用AI)

### 查看数据库
如下图所示,左上角显示当前连接,左侧可查看数据库结构,**选中表双击可查看表格内容**,用户可直接在表中修改记录。
此外,Chat2DB还提供分页功能。
!['console'](/image/tutorial-image/console-checkDatabase.png)

#### 可视化修改表
修改表方法:打开数据库找到表 --> 右键 --> 修改表
**用户可在此修改表名,字段和索引等**
!['sheet'](/image/tutorial-image/update-sheet.png)

**修改列信息**
!['sheet'](/image/tutorial-image/update-sheet2.png)

**修改索引信息**
!['sheet'](/image/tutorial-image/update-sheet3.png)



### 控制台使用
1、使用前请先检查数据源连接和数据库是否正确,若要使用AI请在右上方指定表格。
2、**自然语言转SQL:在文本框处输入自然语言,回车即可生成对应sql语句**
(如果不想用AI功能,也可直接编辑sql语句)
3、点击"执行"按钮(快捷键ctrl+R)
!['console'](/image/tutorial-image/console1.png) <br/><br/>

#### 保存SQL和表
1、执行select语句查看表。控制台下方会显示执行结果,**表格右上角可导出结果**
2、点击“保存按钮”,可以保存SQL到本地。**在右方侧边栏“保存记录”可查看保存的SQL**
3、选中SQL,点击格式化按钮,可以对SQL进行排版、缩进和格式的调整。
!['sql'](/image/tutorial-image/save.png)
Empty file.
14 changes: 14 additions & 0 deletions pages/docs/start-guide/download.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 下载和安装
## 官网下载
https://sqlgpt.cn
微信扫描二维码关注公众号下载

## docker部署
执行命令:
`docker run --name=chat2db -ti -p 10824:10824 -v ~/.chat2db-docker:/root/.chat2db chat2db/chat2db:latest`

提示:
1.这段命令的作用是拉取最新客户端,然后运行docker,名字是 `chat2db` , 并且将 `/root/.chat2db` 挂载到 `~/.chat2db-docker`
2. 如果这里提示 `The container name "/chat2db" is already in use by container`, 代表已经存在容器了,直接运行容器
`docker start chat2db`
3.如果想更新chat2db 则需要先删除容器,执行`docker rm chat2db`,然后重复1的操作。
1 change: 1 addition & 0 deletions pages/docs/start-guide/generate-chart.en-US.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# BI Chart
18 changes: 18 additions & 0 deletions pages/docs/start-guide/generate-chart.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 报表

**点击左侧第二个选项,进入仪表盘**

点击上方“+”添加新的仪表盘,右侧添加数据

!['chart'](/image/tutorial-image/generate-chart.png)

## 添加数据
1.选择数据源和数据库
2.使用查询语句获取所需数据,例:`select * from student`
3.选择图表类型,横纵坐标
!['chart2'](/image/tutorial-image/generate-chart2.png)

**生成图表**
软件会根据输入的数据生成图表,点击右上角更多可以导出为图片
!['chart2'](/image/tutorial-image/generate-chart3.png)

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 快速开始

## 📖 介绍
## 📖 介绍
31 changes: 31 additions & 0 deletions pages/docs/start-guide/getting-started.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 快速入门

## 使用教程
<iframe src="//player.bilibili.com/player.html?aid=659372917&bvid=BV1yh4y1r7NF&cid=1223366275&page=1&autoplay=0" width="100%" height="500" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" sandbox="allow-top-navigation allow-same-origin allow-forms allow-scripts"> </iframe>

## 📖 介绍
&emsp;&emsp; Chat2DB 是一款有开源免费的多数据库客户端工具,支持 windows、mac 本地安装,也支持服务器端部署,web 网页访问。
和传统的数据库客户端软件 Navicat、DBeaver 相比 Chat2DB 集成了 AIGC 的能力,能够将自然语言转换为 SQL,
也可以将 SQL 转换为自然语言,可以给出研发人员 SQL 的优化建议,
极大的提升人员的效率,是 AI 时代数据库研发人员的利器,未来即使不懂 SQL 的运营业务也可以使用快速查询业务数据、生成报表能力。



## ✨ 特性

- AI 智能助手,支持自然语言转 SQL、SQL 转自然语言、SQL 优化建议
- 🔥 智能报表,利用AIGC能力,一句话生成报表
- 👭 支持个人模式、支持团队协作模式,让研发协同效率更高
- 🔌 除支持目前主流数据库外,还支持国产数据库如:达梦、Oceanbase、人大金仓
- ⚙️ 强大的数据管理能力,支持数据表、视图、存储过程、函数、触发器、索引、序列、用户、角色、授权等管理
- 🛡 前端使用 Electron 开发,提供 Windows、Mac、Linux 客户端、网页版本一体化的解决方案
- 🎁 支持环境隔离、线上、日常数据权限分离
<br/>


## 我们的GitHub地址
https://github.com/chat2db/Chat2DB
欢迎!



Binary file added public/image/AI-image/AI-generateSQL-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/AI-image/AI-generateSQL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/AI-image/AI-sql.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/AI-image/sql-convert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/ai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/connect-database2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/console1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/driver.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/driver2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/generate-chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/generate-chart2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/generate-chart3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/manage-database2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/picture1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/save.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/ssh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/update-sheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/update-sheet2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/update-sheet3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/tutorial-image/wrong-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c573b34

Please sign in to comment.