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

tikv-control: make a parameter in right places #9549

Merged
merged 8 commits into from Oct 11, 2022

Conversation

Oreoxmt
Copy link
Collaborator

@Oreoxmt Oreoxmt commented Jul 12, 2022

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.

  • 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)?

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

@Oreoxmt Oreoxmt added type/enhancement This issue/PR improves documentation usability or supplements document content. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. area/engine Indicates that the Issue or PR belongs to the area of TP storage or Cloud storage. ONCALL Relates to documentation oncall. needs-cherry-pick-release-5.4 Should cherry pick this PR to release-5.4 branch. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. labels Jul 12, 2022
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Jul 12, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • 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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 12, 2022
@Oreoxmt Oreoxmt requested review from TomShawn and Connor1996 and removed request for shichun-0415 July 12, 2022 05:17
tikv-control.md Outdated
@@ -229,6 +229,7 @@ Use the `compact` command to manually compact data of each TiKV. If you specify

- Use the `--host` option to specify the TiKV that needs to perform compaction.
- Use the `-d` option to specify the RocksDB that performs compaction. The optional values are `kv` and `raft`.
Copy link
Member

Choose a reason for hiding this comment

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

remove this

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done in a670d19

@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Jul 12, 2022

/verify

tikv-control.md Show resolved Hide resolved
tikv-control.md Outdated
@@ -228,7 +228,7 @@ The properties can be used to check whether the Region is healthy or not. If not
Use the `compact` command to manually compact data of each TiKV. If you specify the `--from` and `--to` options, then their flags are also in the form of escaped raw key.
Copy link
Member

Choose a reason for hiding this comment

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

I refresh the whole description, please update

Compact data of each TiKV manually

Use the compact command to manually compact data of each TiKV.

  • Use the --from and --to options to sepecify the compact range in the form of escaped raw key. If not set, the whole range will be compacted.

  • Use the --region option to compact range of a specific region. If set, --from and --to will be ignored.

  • Use the --db option to specify the RocksDB that performs compaction. The optional values are kv and raft.

  • Use the --threads option allows you to specify the concurrency for the TiKV compaction and its default value is 8. Generally, a higher concurrency comes with a faster compaction speed, which might yet affect the service. You need to choose an appropriate concurrency count based on your scenario.

  • Use the --bottommost option to include or exclude the bottommost files when TiKV performs compaction. The value options are default, skip, and force. The default value is default.

    • default means that the bottommost files are included only when the Compaction Filter feature is enabled.
    • skip means that the bottommost files are excluded when TiKV performs compaction.
    • force means that the bottommost files are always included when TiKV performs compaction.
  • For local mode
    {{< copyable "shell-regular" >}}

$ tikv-ctl --data-dir /path/to/tikv compact --db kv
success!
  • For remote mode
    {{< copyable "shell-regular" >}}
$ tikv-ctl --host ip:port compact --db kv
success!

@Connor1996 Connor1996 requested a review from hicqu July 12, 2022 06:59
@ti-chi-bot ti-chi-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 13, 2022
@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Jul 13, 2022

@Connor1996 @hicqu PTAL

@Oreoxmt Oreoxmt self-assigned this Jul 13, 2022
@Oreoxmt Oreoxmt added the translation/doing This PR's assignee is translating this PR. label Jul 13, 2022
Copy link
Member

@Connor1996 Connor1996 left a comment

Choose a reason for hiding this comment

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

LGTM

@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Aug 16, 2022

/status LGT1

@ti-chi-bot ti-chi-bot added the status/LGT2 Indicates that a PR has LGTM 2. label Oct 11, 2022
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
tikv-control.md Outdated Show resolved Hide resolved
tikv-control.md Outdated Show resolved Hide resolved
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Oct 11, 2022

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 986bd14

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

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

@ti-chi-bot
Copy link
Member

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

@ti-chi-bot
Copy link
Member

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

@ti-chi-bot
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/engine Indicates that the Issue or PR belongs to the area of TP storage or Cloud storage. needs-cherry-pick-release-5.4 Should cherry pick this PR to release-5.4 branch. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 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. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/enhancement This issue/PR improves documentation usability or supplements document content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants