planner: add the doc for hint #13313

Reminiscent · 2023-03-07T08:07:57Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

…hint

ti-chi-bot · 2023-03-07T08:07:59Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

Oreoxmt
ran-huang

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

system-variables.md

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

qw4990

LGTM

songrijie · 2023-03-08T07:11:02Z

system-variables.md

+
+> **注意：**
+>
+> v6.7.0 之前的版本行为和该变量设置为 'OFF' 的行为一致。因此当从老版本升级到新版本时一些行为会发生变化，主要是 join 的连接顺序。如果有不符合预期的情况，可以通过将该参数设置为 'OFF' 的方式或者通过使用 `LEADING()` hint 的方式进行规避，强烈推荐使用后一种方式。


升级默认保持在OFF比较好。

songrijie · 2023-03-08T07:11:32Z

rest LGTM

…hint

system-variables.md

Co-authored-by: Roger Song <roger.song@pingcap.com>

songrijie

LGTM

system-variables.md

ran-huang · 2023-03-09T06:06:10Z

system-variables.md

+- 是否持久化到集群：是
+- 类型：布尔型
+- 默认值：`ON`
+- 这个变量用来控制 join method hint 是否会影响 join reorder 的优化过程，包括 `LEADING()` hint 的使用。默认值为 `ON`，即默认不影响。如果设置为 `OFF`，在一些同时使用 join method hint 和 `LEADING()` hint 的场景下会有冲突产生。


Suggested change

- 这个变量用来控制 join method hint 是否会影响 join reorder 的优化过程，包括 `LEADING()` hint 的使用。默认值为 `ON`，即默认不影响。如果设置为 `OFF`，在一些同时使用 join method hint 和 `LEADING()` hint 的场景下会有冲突产生。

- 这个变量用来控制 join method hint 是否会影响 join reorder 的优化过程，包括 [`LEADING()` hint](/optimizer-hints.md#leadingt1_name--tl_name-) 的使用。默认值为 `ON`，即默认不影响。如果设置为 `OFF`，在一些同时使用 join method hint 和 `LEADING()` hint 的场景下会有冲突产生。

这里是否要解释下哪些 hint 属于 join method hint？

可以解释，不过有点多，是举个例子还是需要多列出来。

至少举一个例子吧。optimizer-hint 这篇文档里也没有提过哪些属于 join method hint，可能会有一点定义不清晰

update. PTAL @ran-huang

Co-authored-by: Ran <huangran.alex@gmail.com>

…hint

Oreoxmt

Rest LGTM

system-variables.md

optimizer-hints.md

Co-authored-by: Aolin <aolinz@outlook.com>

Reminiscent · 2023-03-13T03:28:16Z

Update. PTAL @Oreoxmt

Oreoxmt

Rest LGTM

optimizer-hints.md

Co-authored-by: Aolin <aolinz@outlook.com>

ran-huang · 2023-03-20T07:35:28Z

/merge

ti-chi-bot · 2023-03-20T07:35:31Z

This pull request has been accepted and is ready to merge.

Commit hash: 6c3d771

Reminiscent added 3 commits March 7, 2023 15:35

doc: add the description for MPP hints

4a3e0a0

doc: add the description for tidb_opt_advanced_join_hint variable

6aadd9b

Merge branch 'master' of https://github.com/pingcap/docs-cn into 6.7-…

78487f6

…hint

ti-chi-bot requested a review from TomShawn March 7, 2023 08:08

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 7, 2023

TomShawn reviewed Mar 7, 2023

View reviewed changes

system-variables.md Outdated Show resolved Hide resolved

TomShawn self-assigned this Mar 7, 2023

TomShawn added translation/doing This PR’s assignee is translating this PR. v7.0 area/planner Indicates that the Issue or PR belongs to the area of SQL planner or optimizer. and removed missing-translation-status This PR does not have translation status info. labels Mar 7, 2023

Update system-variables.md

27b248c

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

qw4990 approved these changes Mar 7, 2023

View reviewed changes

ran-huang assigned ran-huang and unassigned TomShawn Mar 7, 2023

ran-huang self-requested a review March 7, 2023 09:23

songrijie reviewed Mar 8, 2023

View reviewed changes

Reminiscent added 3 commits March 8, 2023 17:06

update

7c0c2aa

Merge branch 'master' of https://github.com/pingcap/docs-cn into 6.7-…

a02c94e

…hint

Merge remote-tracking branch 'origin/6.7-hint' into 6.7-hint

9d06d1c

songrijie reviewed Mar 8, 2023

View reviewed changes

system-variables.md Outdated Show resolved Hide resolved

Update system-variables.md

4de05a3

Co-authored-by: Roger Song <roger.song@pingcap.com>

songrijie approved these changes Mar 8, 2023

View reviewed changes

ran-huang reviewed Mar 9, 2023

View reviewed changes

Oreoxmt self-requested a review March 9, 2023 06:58

Reminiscent and others added 2 commits March 9, 2023 17:10

Update system-variables.md

2efb997

Co-authored-by: Ran <huangran.alex@gmail.com>

Update system-variables.md

17adb3d

Co-authored-by: Ran <huangran.alex@gmail.com>

Reminiscent added 2 commits March 10, 2023 15:23

update

bc60676

Merge branch 'master' of https://github.com/pingcap/docs-cn into 6.7-…

5b946cd

…hint

ran-huang approved these changes Mar 10, 2023

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 10, 2023

Oreoxmt reviewed Mar 10, 2023

View reviewed changes

system-variables.md Outdated Show resolved Hide resolved

system-variables.md Outdated Show resolved Hide resolved

optimizer-hints.md Outdated Show resolved Hide resolved

optimizer-hints.md Outdated Show resolved Hide resolved

Reminiscent and others added 4 commits March 13, 2023 11:27

Update system-variables.md

f37de3e

Co-authored-by: Aolin <aolinz@outlook.com>

Update system-variables.md

ed97ee5

Co-authored-by: Aolin <aolinz@outlook.com>

Update optimizer-hints.md

58a472c

Co-authored-by: Aolin <aolinz@outlook.com>

Update optimizer-hints.md

b78567a

Co-authored-by: Aolin <aolinz@outlook.com>

Oreoxmt self-requested a review March 13, 2023 03:28

Oreoxmt reviewed Mar 13, 2023

View reviewed changes

optimizer-hints.md Outdated Show resolved Hide resolved

optimizer-hints.md Outdated Show resolved Hide resolved

optimizer-hints.md Outdated Show resolved Hide resolved

optimizer-hints.md Outdated Show resolved Hide resolved

Oreoxmt self-requested a review March 13, 2023 04:06

Oreoxmt approved these changes Mar 13, 2023

View reviewed changes

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 13, 2023

Apply suggestions from code review

6c3d771

Co-authored-by: Aolin <aolinz@outlook.com>

ran-huang added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Mar 13, 2023

ran-huang mentioned this pull request Mar 13, 2023

planner: add the doc for hint pingcap/docs#12873

Merged

15 tasks

ran-huang added the type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. label Mar 17, 2023

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 20, 2023

ti-chi-bot merged commit 54d29dd into pingcap:master Mar 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

planner: add the doc for hint #13313

planner: add the doc for hint #13313

Reminiscent commented Mar 7, 2023 •

edited

ti-chi-bot commented Mar 7, 2023 •

edited

qw4990 left a comment

songrijie Mar 8, 2023

songrijie commented Mar 8, 2023

songrijie left a comment

ran-huang Mar 9, 2023

ran-huang Mar 9, 2023

Reminiscent Mar 9, 2023

ran-huang Mar 9, 2023

Reminiscent Mar 10, 2023

Oreoxmt left a comment

Reminiscent commented Mar 13, 2023

Oreoxmt left a comment

ran-huang commented Mar 20, 2023

ti-chi-bot commented Mar 20, 2023

	- 这个变量用来控制 join method hint 是否会影响 join reorder 的优化过程，包括 `LEADING()` hint 的使用。默认值为 `ON`，即默认不影响。如果设置为 `OFF`，在一些同时使用 join method hint 和 `LEADING()` hint 的场景下会有冲突产生。
	- 这个变量用来控制 join method hint 是否会影响 join reorder 的优化过程，包括 [`LEADING()` hint](/optimizer-hints.md#leadingt1_name--tl_name-) 的使用。默认值为 `ON`，即默认不影响。如果设置为 `OFF`，在一些同时使用 join method hint 和 `LEADING()` hint 的场景下会有冲突产生。

planner: add the doc for hint #13313

planner: add the doc for hint #13313

Conversation

Reminiscent commented Mar 7, 2023 • edited

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

ti-chi-bot commented Mar 7, 2023 • edited

qw4990 left a comment

Choose a reason for hiding this comment

songrijie Mar 8, 2023

Choose a reason for hiding this comment

songrijie commented Mar 8, 2023

songrijie left a comment

Choose a reason for hiding this comment

ran-huang Mar 9, 2023

Choose a reason for hiding this comment

ran-huang Mar 9, 2023

Choose a reason for hiding this comment

Reminiscent Mar 9, 2023

Choose a reason for hiding this comment

ran-huang Mar 9, 2023

Choose a reason for hiding this comment

Reminiscent Mar 10, 2023

Choose a reason for hiding this comment

Oreoxmt left a comment

Choose a reason for hiding this comment

Reminiscent commented Mar 13, 2023

Oreoxmt left a comment

Choose a reason for hiding this comment

ran-huang commented Mar 20, 2023

ti-chi-bot commented Mar 20, 2023

Reminiscent commented Mar 7, 2023 •

edited

ti-chi-bot commented Mar 7, 2023 •

edited