planner: update the default value of tidb_ignore_inlist_plan_digest to True (#22516)#22694
planner: update the default value of tidb_ignore_inlist_plan_digest to True (#22516)#22694ti-chi-bot wants to merge 3 commits intopingcap:release-8.5from
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
ti-chi-bot
added
for-release
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for a system variable to reflect that its default value has changed from OFF to ON as of v8.5.6. The changes include updating the default value specification and reordering the explanation of the variable's settings to prioritize the new default. Review feedback suggests improving the conciseness and consistency of the setting descriptions by using more direct phrasing, such as "When set to ON (default)" and "When set to OFF", in accordance with style guide rules regarding unnecessary words.
|
|
||
| - When it is the default value `OFF`, TiDB does not ignore the element differences (including the difference in the number of elements) in the `IN` list when generating Plan Digests. The element differences in the `IN` list result in different Plan Digests. | ||
| - When it is set to `ON`, TiDB ignores the element differences (including the difference in the number of elements) in the `IN` list and uses `...` to replace elements in the `IN` list in Plan Digests. In this case, TiDB generates the same Plan Digests for `IN` queries of the same type. | ||
| - When it is the default value `ON`, TiDB ignores the element differences (including the difference in the number of elements) in the `IN` list and uses `...` to replace elements in the `IN` list in Plan Digests. In this case, TiDB generates the same Plan Digests for `IN` queries of the same type. |
There was a problem hiding this comment.
The phrasing 'When it is the default value ON' is wordy. Consider using a more concise structure to improve readability, following the principle of avoiding unnecessary words (Style Guide Rule 24).
| - When it is the default value `ON`, TiDB ignores the element differences (including the difference in the number of elements) in the `IN` list and uses `...` to replace elements in the `IN` list in Plan Digests. In this case, TiDB generates the same Plan Digests for `IN` queries of the same type. | |
| - When set to ON (default), TiDB ignores the element differences (including the difference in the number of elements) in the IN list and uses ... to replace elements in the IN list in Plan Digests. In this case, TiDB generates the same Plan Digests for IN queries of the same type. |
References
- Avoid unnecessary words and repetition. (link)
| - When it is the default value `OFF`, TiDB does not ignore the element differences (including the difference in the number of elements) in the `IN` list when generating Plan Digests. The element differences in the `IN` list result in different Plan Digests. | ||
| - When it is set to `ON`, TiDB ignores the element differences (including the difference in the number of elements) in the `IN` list and uses `...` to replace elements in the `IN` list in Plan Digests. In this case, TiDB generates the same Plan Digests for `IN` queries of the same type. | ||
| - When it is the default value `ON`, TiDB ignores the element differences (including the difference in the number of elements) in the `IN` list and uses `...` to replace elements in the `IN` list in Plan Digests. In this case, TiDB generates the same Plan Digests for `IN` queries of the same type. | ||
| - When it is set to `OFF`, TiDB does not ignore the element differences (including the difference in the number of elements) in the `IN` list when generating Plan Digests. The element differences in the `IN` list result in different Plan Digests. |
There was a problem hiding this comment.
For consistency and conciseness, consider simplifying the phrasing here as well (Style Guide Rule 24).
| - When it is set to `OFF`, TiDB does not ignore the element differences (including the difference in the number of elements) in the `IN` list when generating Plan Digests. The element differences in the `IN` list result in different Plan Digests. | |
| - When set to OFF, TiDB does not ignore the element differences (including the difference in the number of elements) in the IN list when generating Plan Digests. The element differences in the IN list result in different Plan Digests. |
References
- Avoid unnecessary words and repetition. (link)
4 participants
This is an automated cherry-pick of #22516
First-time contributors' checklist
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?