Skip to content

Commit bb06347

Browse files
authored
更新V4 (#24)
1 parent db3d669 commit bb06347

File tree

229 files changed

+5475
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

229 files changed

+5475
-0
lines changed

docusaurus.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ const config = {
3939
lastVersion: 'current',
4040
versions: {
4141
current: {
42+
label: 'v4',
43+
},
44+
v3: {
4245
label: 'v3',
46+
path: '/v3',
4347
},
4448
v2: {
4549
label: 'v2',
19.8 KB
Loading
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: FAQ
3+
---
4+
本章将针对使用过程中的常见问题进行解答。
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: 镜像仓库推荐
3+
---
4+
# 镜像仓库推荐
5+
6+
:::tip
7+
由于网络原因,推荐配置国内镜像源后,拉取SQLE
8+
:::
9+
10+
镜像源地址:https://docker.rainbond.cc
11+
12+
配置参考
13+
14+
![mirror](img/mirrorrepo.jpeg)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: SQL回滚支持程度
3+
---
4+
# 支持回滚的SQL语句类型
5+
6+
参考 https://github.com/actiontech/sqle/discussions/391
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: 支持哪些数据库
3+
---
4+
# 支持的数据库及版本
5+
6+
|数据库类型|验证可用的版本|
7+
|--|--|
8+
|MySQL|5.7.25 、8.0.33|
9+
|PostgreSQL|9.3 – 13|
10+
|Oracle|11.2、12.1、12.2|
11+
|SQL Server|2008、2012、2016|
12+
|DB2|11.5|
13+
|TiDB|4.0.8|
14+
|OceanBase For MySQL|3.5|
15+
|OceanBase For Oracle|4.1|
16+
|TDSQL For InnoDB| |
17+
|Mycat| |
18+
|达梦|V8|
19+
20+
:::tip
21+
当前版本为SQLE验证确认可用的版本,若需要使用其他版本,需自行验证
22+
:::
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Summary
2+
3+
* [产品介绍](intro.md)
4+
* [在线体验](online-demo.md)
5+
* [产品支持](intro.md)
6+
* [企业版社区版功能对比](support/compare.md)
7+
* [社区支持](support/community-support.md)
8+
* [商业支持](support/commercial-support.md)
9+
* [快速开始](quick-usage.md)
10+
* [安装部署](deploy-manual/intro.md)
11+
* [配置文件说明](deploy-manual/config.md)
12+
* [源码安装](deploy-manual/source.md)
13+
* [RPM 安装](deploy-manual/rpm.md)
14+
* [Docker部署](deploy-manual/Docker.md)
15+
* [Docker-Compose部署](deploy-manual/DockerCompose.md)
16+
* [升级说明](deploy-manual/upgrade.md)
17+
* [用户手册](user-manual/intro.md)
18+
* [项目](user-manual/project/intro.md)
19+
* [创建项目【企业版】](user-manual/project/project_create.md)
20+
* [数据源管理](user-manual/project/instance-manager.md)
21+
* [外部数据源同步【企业版】](user-manual/project/instance_syn.md)
22+
* [成员/成员组管理](user-manual/project/group_member.md)
23+
* [审核规则模板](user-manual/project/rule-template-manager.md)
24+
* [审核流程模板](user-manual/project/workflow-template-manager.md)
25+
* [白名单管理【企业版】](user-manual/project/whitelist-manager.md)
26+
* [SQL管控【企业版】](user-manual/project/audit_task/sqlmanage.md)
27+
* [数据导出【企业版】](/docs/user-manual/project/dataexport.md)
28+
* [SQL审核](user-manual/project/quick_audit.md)
29+
* [工单](user-manual/project/workflow/intro.md)
30+
* [创建工单](user-manual/project/workflow/create-workflow.md)
31+
* [审核工单](user-manual/project/workflow/audit-workflow.md)
32+
* [上线工单](user-manual/project/workflow/exec-workflow.md)
33+
* [扫描任务](user-manual/project/audit_task/intro.md)
34+
* [库表元数据](user-manual/project/audit_task/metadata_audit.md)
35+
* [慢日志](user-manual/project/audit_task/slowlog_audit.md)
36+
* [会话SQL扫描任务](user-manual/project/audit_task/processlist_audit.md)
37+
* [百度云RDS慢日志](/docs/user-manual/project/audit_task/baiduyunrds.md)
38+
* [华为云RDS慢日志](/docs/user-manual/project/audit_task/huaweiyunrds.md)
39+
* [应用程序SQL抓取·企业版](/docs/user-manual/project/audit_task/java_application_audit.md)
40+
* [Java探针版应用程序SQL抓取·企业版](/docs/user-manual/project/audit_task/java_agent_audit.md)
41+
* [SQL文件扫描](/docs/user-manual/project/audit_task/SQLfile_audit.md)
42+
* [MyBatis扫描](/docs/user-manual/project/audit_task/mybatis.md)
43+
* [系统设置](user-manual/sys-configuration/intro.md)
44+
* [登录对接](user-manual/sys-configuration/login_syn.md)
45+
* [消息推送](user-manual/sys-configuration/message_syn.md)
46+
* [流程对接](user-manual/sys-configuration/process_syn.md)
47+
* [webhook配置](user-manual/sys-configuration/webhook.md)
48+
* [个性化配置](user-manual/sys-configuration/customize.md)
49+
* [全局配置](/docs/user-manual/sys-configuration/configuration.md)
50+
* [工作台](user-manual/sql-workbench/introduction.md)
51+
* [配置方法](user-manual/sql-workbench/how-to-configure.md)
52+
* [使用定制包快速搭建环境](user-manual/sql-workbench/how-to-use.md)
53+
* [用户管理](user-manual/user-manager/intro.md)
54+
* [用户管理](user-manual/user-manager/user.md)
55+
* [角色管理](user-manual/user-manager/role.md)
56+
* [自定义审核规则](user-manual/customrule.md)
57+
* [规则知识库【企业版】](user-manual/knowledgebase.md)
58+
* [FAQ](/docs/FAQ/intro.md)
59+
* [支持的数据库及版本](/docs/FAQ/whichdatabase.md)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"plugins": ["expandable-chapters"],
3+
"pluginsConfig": {
4+
"fontsettings": {
5+
"theme": "sepia",
6+
"family": "sans",
7+
"size": 2
8+
}
9+
},
10+
"structure" : {
11+
"readme" : "intro.md"
12+
},
13+
"styles": {
14+
"website": "website.css"
15+
},
16+
"author": "ActionTech",
17+
"title": "SQLE manual"
18+
}
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Docker部署
3+
---
4+
# Docker部署
5+
6+
## Docker hub 地址
7+
[actiontech/sqle-ce](https://hub.docker.com/r/actiontech/sqle-ce)
8+
9+
:::tip
10+
推荐配置国内镜像源,参考[镜像推荐](/docs/FAQ/mirror.md)
11+
:::
12+
13+
## Docker 参考命令
14+
```sh
15+
docker run -d -it \
16+
--name sqle-server \
17+
-p 10000:10000 \
18+
-p 10001:10001 \
19+
-e MYSQL_HOST="10.10.10.10" \
20+
-e MYSQL_PORT=3306 \
21+
-e MYSQL_USER="root" \
22+
-e MYSQL_PASSWORD="123456" \
23+
-e MYSQL_DMS_SCHEMA="dms" \
24+
-e MYSQL_SQLE_SCHEMA="sqle" \
25+
actiontech/sqle-ce:latest
26+
```
27+
28+
:::tip
29+
默认提供最新版本的下载镜像,如果需要使用其他版本的镜像,可以访问SQLE的DockerHub选用想要的版本。
30+
:::
31+
32+
33+
### 参数说明
34+
使用环境变量传递参数,这些指定的配置会映射到 /opt/sqle/etc/config.yaml 配置内,指定数据库的配置等。
35+
36+
|变量|说明|
37+
|-|-|
38+
|MYSQL_HOST| 访问地址|
39+
|MYSQL_PORT| 访问端口|
40+
|MYSQL_USER| 数据库用户|
41+
|MYSQL_PASSWORD| 数据库密码|
42+
|MYSQL_DMS_SCHEMA| DMS 服务使用的指定的 schema|
43+
|MYSQL_SQLE_SCHEMA| SQLE 服务使用的指定的 schema|
44+
|DEBUG| 是否输出 debug 日志,默认为false|
45+
|AUTO_MIGRATE_TABLE| 是否自动创建表格和初始化数据,默认为true|
46+
47+
## 注意点
48+
:::tip
49+
使用 docker 命令运行容器需要提前准备 MySQL 服务并且创建对应的数据库 schema,创建数据库的SQL可参考:[RPM 部署](./rpm.md)
50+
:::
51+
:::tip
52+
如果 SQLE 容器启动失败可以使用`docker logs sqle-server`查看启用日志,其中`sqle-server`是容器名称。
53+
:::
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Docker Compose 部署
3+
---
4+
# Docker Compose 部署
5+
6+
## 配置文件
7+
下载地址:[docker-compose.yaml](https://github.com/actiontech/sqle/blob/release-3.2310.x/docker-images/sqle/docker-compose.yaml)
8+
9+
下载地址:[init](https://github.com/actiontech/sqle/tree/release-3.2311.x/docker-images/sqle/init)
10+
11+
## 使用方法
12+
将 docker-compose.yaml 文件和init 文件夹下载到本地目录,并进入目录内,通过环境变量SQLE_IMAGE指定不同版本的 SQLE 镜像,默认是 latest
13+
```
14+
SQLE_IMAGE=actiontech/sqle-ce:latest docker-compose up -d
15+
```
16+
17+
:::tip
18+
自2024年10月起,平台为docker-compose集成了CloudBeaver部署功能。现在,当用户选择使用docker-compose进行部署时,系统将自动处理CloudBeaver的部署工作,用户无需进行任何额外的手动操作。
19+
:::

0 commit comments

Comments
 (0)