Skip to content

Commit

Permalink
3.2410 (#21)
Browse files Browse the repository at this point in the history
* 更新回滚语句FAQ

* 新增镜像地址FAQ

* 回滚部分更新

* 更新docker镜像推荐

* 新增配置文件标记

* 更新数据源插件配置方法

* 工单支持上线到其他数据源

* 更新规则数量

* 新增CI/CD描述

* 更新审核SQL例外

* 新增黑名单

* 新增推送规则描述

* SQL管控中新增高优先级SQL筛选

* Update mirror.md

* Update Docker.md

* Update config.md

* Update config.md

* Update howtouse.md

* Update blacklist-manager.md

* Update blacklist-manager.md

* Update push-rule.md

* Update blacklist-manager.md

* 规则模板导入导出支持csv格式

* 新增CB水印说明

* 新增版本控制

* Update version-management.md

* Update how-to-use.md

* Update how-to-use.md

* Update how-to-use.md

* 支持使用docker-compose安装时自动部署cloudbeaver

* SQL工作台可以直接创建工单

* 移除过期工单自动删除功能

* 默认角色调整

* 新增结构对比文档

* 新增全局dashboard

* 功能对比调整

* Update introduction.md

* Update introduction.md
  • Loading branch information
Gygkimo95 authored Nov 12, 2024
1 parent df493a8 commit 35f7d99
Show file tree
Hide file tree
Showing 17 changed files with 121 additions and 41 deletions.
6 changes: 5 additions & 1 deletion docs/deploy-manual/DockerCompose.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@ title: Docker Compose 部署
将 docker-compose.yaml 文件和init 文件夹下载到本地目录,并进入目录内,通过环境变量SQLE_IMAGE指定不同版本的 SQLE 镜像,默认是 latest
```
SQLE_IMAGE=actiontech/sqle-ce:latest docker-compose up -d
```
```

:::tip
自2024年10月起,平台为docker-compose集成了CloudBeaver部署功能。现在,当用户选择使用docker-compose进行部署时,系统将自动处理CloudBeaver的部署工作,用户无需进行任何额外的手动操作。
:::
4 changes: 2 additions & 2 deletions docs/support/compare.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,13 +314,13 @@ title: 功能对比
<tr>
<td>慢日志审核</td>
<td></td>
<td></td>
<td></td>
<td>✅</td>
</tr>
<tr>
<td>TopSQL</td>
<td></td>
<td></td>
<td></td>
<td>✅</td>
</tr>
<tr>
Expand Down
32 changes: 32 additions & 0 deletions docs/user-manual/Dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: 全局待关注清单
---

全局待关注清单功能旨在帮助业务操作人员和项目管理人集中管理多个项目的审批和SQL问题,提高工作效率和响应速度。

### 功能亮点

* 审批效率提升: 一站式查看所有项目的待处理工单,无需在不同项目间切换。
* SQL问题追踪: 快速识别并优化各项目中的SQL问题,确保问题不被遗漏。


### 操作步骤
点击页面左上角的全局dashboard按钮,查看当前待处理的内容
* 待处理的工单,可以点击跳转
* 待处理的SQL,可以点击查看

**1. 访问全局Dashboard:**

* 点击页面左上角的全局Dashboard按钮,即可查看当前所有待处理的内容。

**2. 查看待处理工单:**

* 在待处理工单面板中,用户可以一目了然地查看所有项目的待处理工单,包括待审批、待上线的工单。
* 点击任意工单,即可直接跳转至详细审批页面,进行快速审批操作。

**3. 查看待解决SQL问题:**

* 在待解决SQL面板中,用户可以跟踪和排查各项目中存在的SQL问题,这些问题SQL来源于SQL管控中超过预定标准的SQL。
* 点击具体的SQL问题,即可查看详细信息,并进行针对性的优化。

![dashboard](img/dashboard.png)
Binary file added docs/user-manual/img/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs/user-manual/project/Structure-Comparison.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: 结构对比
---

结构对比功能旨在帮助用户确保不同环境的数据库结构保持同步,让用户能够快速、准确地识别和同步不同数据库之间的差异,从而提高团队协作效率,减少因数据库不一致导致的问题。

### 使用场景

1. 多人协作开发:
当多个开发人员在不同的数据库上工作时,结构对比功能可以帮助您快速识别和合并他们的变更,确保所有开发环境的数据库结构一致。

2. 多环境部署:
在将应用从开发环境迁移到测试或生产环境时,使用结构对比功能可以确保数据库结构的一致性,避免因结构差异导致的应用错误。

3. 数据库迁移:
在进行数据库迁移时,结构对比功能可以帮助您发现源数据库和目标数据库之间的差异,确保迁移过程中数据的完整性和一致性。

4. 版本控制:
结构对比功能可以作为版本控制系统的补充,帮助您跟踪数据库结构的变更历史,便于回滚和审计。

### 支持的数据源类型
* MySQL

### 操作步骤

**1. 选择数据库对象:**

* 进入结构对比功能页面。
* 选择需要对比的两个数据库对象。
* 点击“执行对比”,系统将自动展示所有差异。

![compare1](img/compare1.png)
**2. 查看具体差异:**

* 当系统检测到差异时,点击数据对象后的“查看详情”按钮。
* 直观对比建表语句的具体差异,一目了然。
![compare2](img/compare2.png)
**3. 同步数据库结构:**

* 如果需要使两个数据源的库表结构保持一致,可以点击“生成变更SQL”按钮。
* 系统将提供将两端数据库结构同步所需的SQLcompa语句。
* 用户可以直接使用这些SQL语句,或者创建变更工单,轻松消除不同环境间的差异,确保数据一致性。
![compare3](img/compare3.png)
Binary file added docs/user-manual/project/img/compare1.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 docs/user-manual/project/img/compare2.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 docs/user-manual/project/img/compare3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 8 additions & 3 deletions docs/user-manual/sql-workbench/how-to-configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,18 @@ title: 配置方法
SQLE目前支持的CloudBeaver版本包括22.2.0、22.2.1、22.2.3、22.3.1、23.2.1版本,推荐使用23.2.1版本
:::

docker 部署:https://github.com/dbeaver/cloudbeaver/wiki/Run-Docker-Container
* docker 部署:https://github.com/dbeaver/cloudbeaver/wiki/Run-Docker-Container
* 源码安装:https://github.com/dbeaver/cloudbeaver/wiki/Build-and-deploy

源码安装:https://github.com/dbeaver/cloudbeaver/wiki/Build-and-deploy

```

:::note
1. docker启动指令参考
```
docker run -d --restart unless-stopped --name cloudbeaver --privileged -it -p 8978:8978 dbeaver/cloudbeaver:23.2.1
```
2. 自2024年10月起,平台为docker-compose集成了CloudBeaver部署功能。现在,当用户选择使用[docker-compose](/docs/deploy-manual/DockerCompose.md)进行部署时,系统将自动处理CloudBeaver的部署工作,用户无需进行任何额外的手动操作。
:::

### 配置CloudBeaver
#### 步骤一 修改CloudBeaver配置文件cloudbeaver.conf
Expand Down
11 changes: 11 additions & 0 deletions docs/user-manual/sql-workbench/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,17 @@ SQLE通过集成CloudBeaver,使得SQLE具备数据库操作的能力,方便
按要求修改SQL, 再次执行, 如果审核通过将会执行当前SQL
![success](img/success.png)

:::tip

**重要业务操作提示**:请注意,当SQL被系统拦截时,通常是因为系统需要确保所有关键操作都符合安全和合规标准,如drop操作被识别为高危操作而被拦截。此时,如用户仍需上线当前SQL,请按照以下步骤操作:

* 点击界面上的`创建工单`按钮。
* 进入工单创建页面,填写工单信息并提交,这里用户可以详细说明SQL的业务必要性和紧急性。
* 提交工单后,SQL将进入审批流程,通过人工审批,确认SQL上线操作。一旦获得批准,业务SQL可以迅速部署上线,确保业务连续性不受影响。
:::



### 权限控制场景
假设公司需要确保开发团队和业务分析师只能访问他们工作所需的数据,无法直接修改原始数据,所有对生产数据的变更都经过严格审批,可以对用户数据库操作进行精细化访问控制,确保用户只能执行其被授权的操作。
#### 步骤一 SQLE平台配置用户及角色
Expand Down
13 changes: 0 additions & 13 deletions docs/user-manual/sys-configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,10 @@
title: 全局配置
---
SQLE支持管理员对平台基础配置进行统一管理,目前支持修改的配置项包括:
* 已完成的工单自动过期时间;
* 操作记录过期时间;
* URL地址前缀;


### 已完成的工单自动过期时间

#### 使用场景
SQLE会定时回收已完成的工单,目前该过期时间默认为30天。如果用户需要自定义过期时间,可在全局配置中修改。

#### 填写范例
* 进入全局配置页面,点击`修改`
* 点击`已完成的工单过期时间`输入框;
* 输入预期的过期时间,例如:360小时;
* 点击`提交`,保存配置;
* 此时查看项目工单列表,已完成15天以上的工单将被删除;

### 操作记录过期时间

#### 使用场景
Expand Down
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 docs/user-manual/user-manager/img/privilege.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 removed docs/user-manual/user-manager/img/rolelist.png
Binary file not shown.
Binary file removed docs/user-manual/user-manager/img/usergrouplist.png
Binary file not shown.
40 changes: 18 additions & 22 deletions docs/user-manual/user-manager/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,29 @@ title: 角色管理
# 角色管理
当需要为用户设置动作权限时,可使用角色管理配置动作组合。

如用户需要有创建工单、审核工单、SQL查询的动作权限,管理员可以在角色管理创建一个角色,并绑定创建工单、审核工单、SQL查询这三个动作,随后只需将此角色关联至指定成员,即可完成用户的动作权限设置。
### 默认角色
当前支持的默认角色有如下三种:
![role](img/defaultrole.png)

### 操作步骤
### 如何新建角色
用户可以根据权限配置需要,自定义角色权限。

#### 操作步骤
* 点击顶部导航栏`更多`按钮,点击平台管理栏目下的`用户中心`选项,查看角色管理标签。
* 点击列表右上角`创建角色`按钮,填写相关信息
* 角色名
* 角色描述
* 选择动作权限:配置该角色所拥有的操作权限,SQLE平台支持的动作权限如下

* 角色名:给角色起一个名字。
* 角色描述:简要描述角色的用途。
* 选择动作权限:勾选这个角色可以执行的操作,以下是平台支持的操作权限
![privilege](img/privilege.png)

|权限名|权限码|权限说明|
|--|--|------|
|查看他人工单|20100|当角色拥有该动作权限时,角色可以查看绑定的数据源上其他用户创建的工单|
|创建/编辑工单|20200|当角色拥有该动作权限时,角色可以在绑定的数据源上创建工单|
|工单审批|20300|当审核流程模版中的某个审核步骤指定为允许所有有权限的用户审批时, 拥有此权限的用户将可以审批对应工单|
|审核任务查看|30100|拥有此权限的用户可以查看所有审核任务, 无此权限的用户只能查看自己创建审核任务|
|审核任务创建|30200|拥有此权限的用户可以创建审核任务|
|sql查询|40100|拥有此权限的用户可以上线工单|

### 执行结果
可在角色列表查看创建的角色信息。
### 查看和管理角色
#### 查看角色
创建后,用户可以在角色列表查看查看所有角色的详细信息。

![role](img/rolelist.png)

### 后续步骤
* 添加成员/成员组:项目管理员在项目中添加成员/成员组时,需要绑定成员/成员组在对应数据源上的角色权限,可参考[成员/成员组管理](../project/group_member.md)
#### 编辑角色
* 如果需要修改角色信息,点击角色旁边的`编辑`按钮。请注意,角色名一旦创建无法更改.

### 更多操作
* 编辑角色:点击角色列表的`编辑`按钮,编辑角色信息。角色名不可更改,可设置角色禁用,则对应权限不会生效。
* 删除角色:点击角色列表的`删除`按钮,删除角色信息。
#### 删除角色
* 如果需要删除某个角色,点击角色旁边的`删除`按钮。这将移除角色及其权限设置。
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ const sidebars = {
label: 'SQL开发',
items: [
"user-manual/project/dataexport",
"user-manual/project/Structure-Comparison",
"user-manual/project/quick_audit",
"user-manual/project/IDEaudit",
"user-manual/project/audit_task/mybatis",
Expand Down Expand Up @@ -130,6 +131,7 @@ const sidebars = {
"user-manual/user-manager/account",
],
},
"user-manual/Dashboard",
"user-manual/customrule",
"user-manual/knowledgebase",
"user-manual/allinstance",
Expand Down

0 comments on commit 35f7d99

Please sign in to comment.