Skip to content

Commit 9b009ac

Browse files
Gygkimo95Gygkimo95
authored
4.2502 (#25)
* 更新V4 * 新增SQL下钻分析 * 新增SQL重写 * 删除了一个无用的文件 * 1 * 多因素认证新增 * 知识图谱更新 * 新增acitondb对比 * 功能对比更新 * Update MFA.md * Update sqlrewrite.md * Update knowledgebase.md * Update MFA.md * 调整2FA文档 * Update sqlrewrite.md * Update MFA.md
1 parent bb06347 commit 9b009ac

File tree

14 files changed

+276
-24
lines changed

14 files changed

+276
-24
lines changed

‎docs/support/compare.md‎

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ title: 功能对比
1313
<td>企业版</td>
1414
</tr>
1515
<tr>
16-
<td rowspan="12">支持的数据源类型</td>
16+
<td rowspan="13">支持的数据源类型</td>
1717
<td>MySQL</td>
1818
<td>✅</td>
1919
<td>✅</td>
@@ -84,6 +84,12 @@ title: 功能对比
8484
<td></td>
8585
<td></td>
8686
<td>✅</td>
87+
</tr>
88+
<tr>
89+
<td>ActionDB</td>
90+
<td></td>
91+
<td></td>
92+
<td>✅</td>
8793
</tr>
8894
<tr>
8995
<td rowspan="4">审核方式</td>
@@ -341,6 +347,19 @@ title: 功能对比
341347
<td></td>
342348
<td>✅</td>
343349
</tr>
350+
<tr>
351+
<td rowspan="2">SQL优化</td>
352+
<td>SQL合规重写</td>
353+
<td></td>
354+
<td> </td>
355+
<td>✅</td>
356+
</tr>
357+
<tr>
358+
<td>智能调优</td>
359+
<td></td>
360+
<td></td>
361+
<td>✅</td>
362+
</tr>
344363
<tr>
345364
<td rowspan="2">数据操作</td>
346365
<td>集成CloudBeaver-提供在线SQL客户端</td>
@@ -485,7 +504,7 @@ title: 功能对比
485504
目前支持的数据源类型中，除MySQL为社区版，其他均为企业版。
486505
:::
487506
### MySQL系
488-
<table border="0" cellspacing="0" cellpadding="5">
507+
<table border="0" cellspacing="0" cellpadding="6">
489508
<tr>
490509
<td width="150"> </td>
491510
<td width="500"> </td>
@@ -494,6 +513,7 @@ title: 功能对比
494513
<td>TDSQL for InnoDB</td>
495514
<td>OceanBase For MySQL</td>
496515
<td>TiDB</td>
516+
<td>ActionDB</td>
497517
</tr>
498518
<tr>
499519
<td rowspan="5">功能</td>
@@ -503,6 +523,7 @@ title: 功能对比
503523
<td>√</td>
504524
<td>√</td>
505525
<td>√</td>
526+
<td>√</td>
506527
</tr>
507528
<tr>
508529
<td>SQL上下文</td>
@@ -511,6 +532,7 @@ title: 功能对比
511532
<td>√</td>
512533
<td> </td>
513534
<td> </td>
535+
<td> </td>
514536
</tr>
515537
<tr>
516538
<td>元数据检查</td>
@@ -519,6 +541,7 @@ title: 功能对比
519541
<td>√</td>
520542
<td>√</td>
521543
<td>√</td>
544+
<td>√</td>
522545
</tr>
523546
<tr>
524547
<td>SQL回滚</td>
@@ -527,6 +550,7 @@ title: 功能对比
527550
<td> </td>
528551
<td>√</td>
529552
<td>√</td>
553+
<td>√</td>
530554
</tr>
531555
<tr>
532556
<td>上线中止</td>
@@ -535,6 +559,7 @@ title: 功能对比
535559
<td>√</td>
536560
<td>√</td>
537561
<td>√</td>
562+
<td>√</td>
538563
</tr>
539564
<tr>
540565
<td rowspan="12">扫描任务</td>
@@ -544,6 +569,7 @@ title: 功能对比
544569
<td> </td>
545570
<td> </td>
546571
<td> </td>
572+
<td> </td>
547573
</tr>
548574
<tr>
549575
<td>慢日志</td>
@@ -552,6 +578,7 @@ title: 功能对比
552578
<td> </td>
553579
<td> </td>
554580
<td> </td>
581+
<td> </td>
555582
</tr>
556583
<tr>
557584
<td>Processlist</td>
@@ -560,6 +587,7 @@ title: 功能对比
560587
<td> </td>
561588
<td> </td>
562589
<td> </td>
590+
<td> </td>
563591
</tr>
564592
<tr>
565593
<td>TopSQL</td>
@@ -568,6 +596,7 @@ title: 功能对比
568596
<td> </td>
569597
<td>√</td>
570598
<td> </td>
599+
<td>√</td>
571600
</tr>
572601
<tr>
573602
<td>TiDB审计日志</td>
@@ -576,6 +605,7 @@ title: 功能对比
576605
<td> </td>
577606
<td> </td>
578607
<td>√</td>
608+
<td> </td>
579609
</tr>
580610
<tr>
581611
<td>MyBatis</td>
@@ -584,6 +614,7 @@ title: 功能对比
584614
<td>√</td>
585615
<td>√</td>
586616
<td>√</td>
617+
<td>√</td>
587618
</tr>
588619
<tr>
589620
<td>阿里RDS MySQL慢日志</td>
@@ -592,6 +623,7 @@ title: 功能对比
592623
<td> </td>
593624
<td> </td>
594625
<td> </td>
626+
<td> </td>
595627
</tr>
596628
<tr>
597629
<td>阿里RDS MySQL审计日志</td>
@@ -600,6 +632,7 @@ title: 功能对比
600632
<td> </td>
601633
<td> </td>
602634
<td> </td>
635+
<td> </td>
603636
</tr>
604637
<tr>
605638
<td>百度云RDS MySQL慢日志扫描</td>
@@ -608,6 +641,7 @@ title: 功能对比
608641
<td> </td>
609642
<td> </td>
610643
<td> </td>
644+
<td> </td>
611645
</tr>
612646
<tr>
613647
<td>SQL文件扫描</td>
@@ -616,6 +650,7 @@ title: 功能对比
616650
<td>√</td>
617651
<td>√</td>
618652
<td>√</td>
653+
<td>√</td>
619654
</tr>
620655
<tr>
621656
<td>应用程序抓取</td>
@@ -624,6 +659,7 @@ title: 功能对比
624659
<td></td>
625660
<td></td>
626661
<td></td>
662+
<td> </td>
627663
</tr>
628664
<tr>
629665
<td>自定义</td>
@@ -632,6 +668,7 @@ title: 功能对比
632668
<td>√</td>
633669
<td>√</td>
634670
<td>√</td>
671+
<td>√</td>
635672
</tr>
636673
<tr>
637674
<td>其他</td>
@@ -641,6 +678,7 @@ title: 功能对比
641678
<td>162</td>
642679
<td>150</td>
643680
<td>153</td>
681+
<td>150</td>
644682
</tr>
645683
</table>
646684

‎docs/user-manual/img/knowledge.png‎

373 KB
Loading

‎docs/user-manual/img/knowledgebase-use.png‎

-228 KB
Loading

‎docs/user-manual/img/knowledgebase-use2.png‎

244 KB
Loading

‎docs/user-manual/knowledgebase.md‎

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,48 @@
1-
---
2-
title: 规则知识库
3-
---
1+
# 规则知识库
42

5-
## 使用场景
6-
规则知识库是用于帮助用户理解规则背景、原理、优化建议以及规范SQL示例的页面。通过规则知识库，用户可以更深入和全面地了解规则，以实现更高效的开发和优化工作。
3+
## 功能概述
74

5+
### 数据库语法知识图谱
6+
数据库语法知识图谱是一款将复杂的SQL语法规范转化为直观图形化展示的工具，帮助用户快速查找、理解和应用SQL规范知识。用户可以将知识图谱作为起点，更深入和全面地了解规则，以实现更高效的开发和优化工作。
87

9-
## 使用入口
8+
## 应用场景
9+
10+
- 日常开发需要查询特定SQL语法规范时
11+
- 系统性学习数据库规范时
12+
- 新员工入职培训时
1013

11-
1. 在系统设置中点击`查看规则`，点击具体规则，再点击`规则知识库`标签下的`查看更多`按钮，即可进入规则知识库详情；
12-
2. 在SQL审核、工单、扫描任务详情页面中，点击触发的规则说明后的`查看更多`按钮，即可进入规则知识库详情；
14+
### 核心功能
1315

14-
## 范围
16+
- 知识图谱可视化展示
17+
- 快速检索定位
18+
- 详细规范说明
1519

16-
规则知识库目前支持内置规则和自定义规则的编辑和查看。
20+
## 主要特点
1721

18-
## 编辑步骤
22+
- **直观可视化**：将复杂的SQL语法规范转化为直观的知识图谱
23+
- **精准定位**：可快速定位到需要的语法节点，如"varchar长度限制"、"索引命名规则"等
24+
- **学习效率高**：新人1小时可掌握原本需3天才能理清的知识脉络
1925

20-
### 限制
26+
## 前置条件
2127

22-
目前，只有平台管理员具有规则知识库的编辑权限，以确保知识库中的信息准确且权威。
28+
- 获取该数据源类型的知识库License
29+
30+
## 使用入口
2331

24-
### 编辑
32+
1. 知识图谱入口：菜单栏右上角
33+
2. 规则知识库入口：
34+
- 系统设置 → 查看规则 → 规则知识库 → 查看更多
35+
- SQL审核/工单/扫描任务详情页 → 规则说明 → 查看更多
2536

26-
平台管理员可以按照以下步骤编辑规则知识库内容：
37+
![knowledge](img/knowledge.png)
2738

28-
1. 登录平台并进入规则知识库页面，入口可以参考[使用入口](#使用入口)
29-
2. 点击'编辑'按钮，即可修改规则对应的知识库内容。
39+
## 操作指南
3040

31-
### 操作结果
41+
1. 进入知识图谱页面
42+
2. 在搜索框中输入关键词或浏览图谱结构
43+
3. 点击感兴趣的节点查看详细规范
44+
4. 查看相关规范说明和示例
3245

33-
![knowledgebase-use](img/knowledgebase-use.png)
46+
![knowledge-use](img/knowledgebase-use.png)
47+
![knowledge-use2](img/knowledgebase-use2.png)
3448

35-
:::tip
36-
目前，平台已为MySQL和TDSQL两种数据库类型的规则填充了规则知识库，并正致力于为其他数据库类型提供相应的知识库内容。
37-
:::

‎docs/user-manual/project/audit_task/SQLdrilldown.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
# SQL下钻分析
3+
4+
## 功能概述
5+
6+
### 功能用途
7+
SQL下钻功能帮助用户追踪和分析SQL查询性能变化，精确定位性能劣化的时间点和原因，从而快速解决SQL查询性能问题。
8+
9+
### 应用场景
10+
- 原本高效的SQL查询突然变得缓慢时。
11+
- 需要追溯SQL性能变化历史时。
12+
- 想要对比不同时间点的SQL执行计划差异时。
13+
14+
### 主要特点
15+
- 历史性能曲线可视化展示。
16+
- 自动识别性能突变的关键时间点。
17+
- 执行计划智能对比。
18+
- 一键定位性能劣化根因。
19+
20+
### 预期效果
21+
快速发现并解决SQL性能问题，避免因查询效率低下而影响系统整体性能，提高数据库运维和优化的工作效率。
22+
23+
24+
25+
## 前置条件
26+
- 开启SQL管控配置，管控如慢SQL、TopSQL等数据对象。
27+
28+
29+
30+
## 操作指南
31+
32+
### 功能入口位置
33+
- SQL管控页面，点击`SQL分析`。
34+
35+
### 操作步骤
36+
1. 选择需要分析的SQL语句。
37+
2. 查看`Cost趋势`曲线图了解性能变化。
38+
3. 定位性能突变的关键时间点。
39+
4. 点击`执行计划对比`按钮，查看前后执行计划的差异。
40+
5. 根据比对结果，确定性能劣化的根本原因。
41+
42+
![drilldown](img/drilldown.png)
43+
44+
45+
## 使用规则
46+
47+
### 注意事项
48+
- 平台保存30天历史数据。
49+
- 执行计划的变化可能受多种因素影响，请综合分析。
50+
51+
### 使用建议
52+
- 定期使用此功能检查关键SQL的性能变化。
53+
- 在系统环境发生变更后，及时分析重要SQL的执行情况。
54+
- 将发现的性能问题及时记录并解决，避免问题累积。
55+

‎docs/user-manual/project/audit_task/img/drilldown.png‎

165 KB
Loading

‎docs/user-manual/project/sql-improve/img/rewrite.png‎

267 KB
Loading

‎docs/user-manual/project/sql-improve/introduction.md‎

Whitespace-only changes.

‎docs/user-manual/project/sql-improve/sqlrewrite.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
3+
# SQL合规重写
4+
5+
## 功能概述
6+
### 功能用途
7+
SQL合规重写功能帮助用户快速将不合规的SQL语句转换为符合规范的SQL语句，避免因SQL不规范而被打回的情况。
8+
9+
### 应用场景
10+
- 当您的SQL语句因不合规被打回需要修改时
11+
- 当您理解问题原因，但对具体优化方案没有思路时
12+
- 当您需要快速将SQL语句调整为符合规范的形式时
13+
14+
### 主要特点
15+
- 一键重写：基于触发的审核规则自动提供重写方案，解放您的双手，告别反复修改；
16+
- 对比清晰：清晰对照修改前后的SQL，使改动一目了然；
17+
- 原理解读：每条规则都配备详细解释说明，边用边学；
18+
- 风险提醒：自动提示重要变更，确保改写安全。
19+
20+
### 预期效果
21+
通过简单的一键操作，您可以将不规范的SQL语句转换为符合标准的形式，提高开发效率，减少因SQL不规范导致的返工。
22+
23+
24+
## 操作指南
25+
### 功能入口位置
26+
- 在SQL审核结果页面的操作列中，点击"SQL合规重写"按钮即可使用此功能。
27+
28+
### 操作步骤
29+
1. 点击"SQL合规重写"按钮；
30+
2. 系统自动分析并给出重写建议；
31+
3. 查看对比说明，确认无误后一键应用。
32+
33+
![rewrite](img/rewrite.png)
34+
## 注意事项
35+
- 重写功能是基于您配置的审核规则进行的，建议您合理配置审核规则
36+
- 系统会针对重要变更提供风险提醒，请仔细确认后再应用
37+
- 重写后的SQL虽然符合通用的SQL审核规范，但您可能需要根据具体业务场景进行进一步优化
38+

0 commit comments

Comments
 (0)