Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

planner: add docs for some variables #9943

Merged
merged 31 commits into from
Aug 18, 2022
Merged

planner: add docs for some variables #9943

merged 31 commits into from
Aug 18, 2022

Conversation

qw4990
Copy link
Contributor

@qw4990 qw4990 commented Aug 11, 2022

First-time contributors' checklist

What is changed, added or deleted? (Required)

Close #3155

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.

  • master (the latest development version)
  • v6.2 (TiDB 6.2 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

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

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 11, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • Oreoxmt
  • TomShawn

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.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 11, 2022
@TomShawn TomShawn self-assigned this Aug 11, 2022
@TomShawn TomShawn added area/planner Indicates that the Issue or PR belongs to the area of SQL planner or optimizer. add-missing-docs Add missing system variables to documentation and removed missing-translation-status This PR does not have translation status info. labels Aug 11, 2022
@TomShawn TomShawn self-requested a review August 11, 2022 11:16
@TomShawn TomShawn added the translation/doing This PR's assignee is translating this PR. label Aug 11, 2022
@TomShawn
Copy link
Contributor

/cc @songrijie

system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
@songrijie
Copy link
Contributor

Others LGTM

system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
qw4990 and others added 4 commits August 16, 2022 15:23
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@ti-chi-bot 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 Aug 18, 2022
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
Co-authored-by: Aolin <aolinz@outlook.com>
@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 676a458

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 18, 2022
@ti-chi-bot ti-chi-bot merged commit 44108aa into pingcap:master Aug 18, 2022
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #10054.

@TomShawn TomShawn added the needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. label Oct 9, 2022
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #10668.

ti-chi-bot pushed a commit to ti-chi-bot/docs that referenced this pull request Oct 9, 2022
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
TomShawn pushed a commit to ti-chi-bot/docs that referenced this pull request Oct 9, 2022
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@@ -1724,6 +1764,35 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
- This variable is used to set whether the optimizer executes the optimization operation of pushing down the aggregate function to the position before Join, Projection, and UnionAll.
- When the aggregate operation is slow in query, you can set the variable value to ON.

### tidb_opt_cartesian_bcj
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect variable name. Fixed in #10782

- Default value: `3.0`
- Indicates the CPU cost of starting a Golang goroutine in TiDB. This variable is internally used in the [Cost Model](/cost-model.md), and it is **NOT** recommended to modify its value.

### tidb_opt_cop_cpu_factor
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect variable name. Fixed in #10782

- Default value: `3.0`
- Indicates the CPU cost for TiDB to process one row. This variable is internally used in the [Cost Model](/cost-model.md), and it is **NOT** recommended to modify its value.

### tidb_opt_desc_scan_factor
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect variable name. Fixed in #10782

@@ -1833,6 +1938,15 @@ mysql> desc select count(distinct a) from test.t;
- Default value: `ON`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect default value. Fixed in #10782.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add-missing-docs Add missing system variables to documentation area/planner Indicates that the Issue or PR belongs to the area of SQL planner or optimizer. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document missing system variables
6 participants