This is an automated email from the ASF dual-hosted git repository.
kassiez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 32e01c9dd0f [Improvement](docs) refine query acceleration doc (#1607)
32e01c9dd0f is described below
commit 32e01c9dd0f8252cf791c1c8010a74a78bfbfed4
Author: xzj7019 <[email protected]>
AuthorDate: Wed Dec 25 20:23:59 2024 +0800
[Improvement](docs) refine query acceleration doc (#1607)
## Versions
- [x] dev
- [ ] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
docs/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md | 4 ++++
.../tuning/tuning-plan/controlling-hints-with-cbo-rule.md | 4 ++++
.../tuning/tuning-plan/reordering-join-with-leading-hint.md | 2 +-
.../query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md | 4 ++++
.../tuning/tuning-plan/controlling-hints-with-cbo-rule.md | 4 ++++
5 files changed, 17 insertions(+), 1 deletion(-)
diff --git
a/docs/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
b/docs/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
index fada408ad5e..93979be0c4c 100644
--- a/docs/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
+++ b/docs/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
@@ -27,6 +27,10 @@ under the License.
Doris supports the use of hints to adjust the type of data shuffle in Join
operations, thereby optimizing query performance. This section provides
detailed instructions on how to specify the Join Shuffle type in Doris using
hints.
+:::caution Note
+Currently, Doris has good out-of-the-box capabilities. This means that in most
scenarios, Doris will adaptively optimize performance in various scenarios, and
users do not need to manually control hints for performance tuning. The content
introduced in this chapter is mainly for professional tuners, and business
personnel only need a simple understanding.
+:::
+
Currently, Doris supports two independent [Distribute
Hint](../../../query-acceleration/hints/distribute-hint.md), `[shuffle]` and
`[broadcast]`, to specify the Distribute Type for the right table in a Join.
The Distribute Type should be placed before the right table in the Join,
enclosed in square brackets `[]`. Additionally, Doris can specify the shuffle
mode by using the Leading Hint in conjunction with the Distribute Hint (for
more details, refer to [Reordering Join With Leading Hint [...]
Examples are as follows:
diff --git
a/docs/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
b/docs/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
index 34e93ad9d44..f71bb303bee 100644
---
a/docs/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
+++
b/docs/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
@@ -33,6 +33,10 @@ The query optimizer applies a series of rules when
generating execution plans. T
In some cases, database administrators or developers may need more granular
control over the query optimization process. Based on this, this document will
introduce how to use query hints to manage CBO rules.
+:::caution Note
+Currently, Doris has good out-of-the-box capabilities. This means that in most
scenarios, Doris will adaptively optimize performance in various scenarios, and
users do not need to manually control hints for performance tuning. The content
introduced in this chapter is mainly for professional tuners, and business
personnel only need a simple understanding.
+:::
+
The basic syntax for CBO rule control hints is as follows:
```sql
diff --git
a/docs/query-acceleration/tuning/tuning-plan/reordering-join-with-leading-hint.md
b/docs/query-acceleration/tuning/tuning-plan/reordering-join-with-leading-hint.md
index 4733feb8ca4..dc743a8975f 100644
---
a/docs/query-acceleration/tuning/tuning-plan/reordering-join-with-leading-hint.md
+++
b/docs/query-acceleration/tuning/tuning-plan/reordering-join-with-leading-hint.md
@@ -29,7 +29,7 @@ under the License.
The Leading Hint feature allows users to manually specify the join order of
tables in a query, optimizing the performance of complex queries in specific
scenarios. This article will describe in detail how to use Leading Hint to
control the join order in Doris. For detailed usage instructions, please refer
to the [leading hint](../../../query-acceleration/hints/leading-hint.md)
document.
:::caution Note
-Currently, Doris has good out-of-the-box capabilities. This means that in most
scenarios, Doris will adaptively optimize performance in various scenarios, and
users do not need to manually control hints for business tuning. The content
introduced in this chapter is mainly for professional tuners, and business
personnel only need a simple understanding.
+Currently, Doris has good out-of-the-box capabilities. This means that in most
scenarios, Doris will adaptively optimize performance in various scenarios, and
users do not need to manually control hints for performance tuning. The content
introduced in this chapter is mainly for professional tuners, and business
personnel only need a simple understanding.
:::
## Case 1: Adjusting the Left and Right Table Order
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
index 32a653b03e4..615530cf804 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/adjusting-join-shuffle.md
@@ -28,6 +28,10 @@ under the License.
Doris 支持使用 Hint 来调整 Join 操作中数据 Shuffle 的类型，从而优化查询性能。本节将详细介绍如何在 Doris 中利用 Hint
来指定 Join Shuffle 的类型。
+:::caution 注意
+当前 Doris 已经具备良好的开箱即用的能力，也就意味着在绝大多数场景下，Doris 会自适应的优化各种场景下的性能，无需用户来手工控制 hint
来进行业务调优。本章介绍的内容主要面向专业调优人员，业务人员仅做简单了解即可。
+:::
+
目前，Doris 支持两种独立的 [Distribute
Hint](../../../query-acceleration/hints/distribute-hint.md)，`[shuffle] ` 和
`[broadcast]`，用来指定 Join 右表的 Distribute Type。Distribute Type 需置于 Join 右表之前，采用中括号
`[]` 的方式。同时，Doris 也可以通过 Leading Hint 配合 Distribute Hint 的方式，指定 shuffle 方式（详见[使用
Leading Hint 控制 Join 顺序](reordering-join-with-leading-hint.md)章节相关介绍）。
示例如下：
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
index d3be60d2c70..fcb6d6aaa73 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/query-acceleration/tuning/tuning-plan/controlling-hints-with-cbo-rule.md
@@ -33,6 +33,10 @@ under the License.
在某些情况下，数据库管理员或开发人员可能需要对查询优化过程进行更为精细的控制。基于此，本文档将介绍如何使用查询 Hint 来管理 CBO 规则。
+:::caution 注意
+当前 Doris 已经具备良好的开箱即用的能力，也就意味着在绝大多数场景下，Doris 会自适应的优化各种场景下的性能，无需用户来手工控制 hint
来进行业务调优。本章介绍的内容主要面向专业调优人员，业务人员仅做简单了解即可。
+:::
+
CBO 规则控制 Hint 的基本语法如下所示：
```sql
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
