Skip to content

DM: update DM mydumper extra-args example config#21421

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
JQWong7:fix-21167
Jul 18, 2025
Merged

DM: update DM mydumper extra-args example config#21421
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
JQWong7:fix-21167

Conversation

@JQWong7
Copy link
Copy Markdown
Contributor

@JQWong7 JQWong7 commented Jul 18, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

close #21167

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)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 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 ti-chi-bot Bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Jul 18, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jul 18, 2025

Welcome @River2000i!

It looks like this is your first PR to pingcap/docs 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs. 😃

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jul 18, 2025

Hi @River2000i. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ti-chi-bot ti-chi-bot Bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. missing-translation-status This PR does not have translation status info. labels Jul 18, 2025
@pingcap-cla-assistant
Copy link
Copy Markdown

pingcap-cla-assistant Bot commented Jul 18, 2025

CLA assistant check
All committers have signed the CLA.

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 18, 2025
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @River2000i, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation for TiDB Data Migration (DM) by correcting the example configuration for mydumper's extra-args. Specifically, it changes the recommended consistency setting from none to auto in two key documentation files, aligning the examples with potentially better practices or updated defaults for data consistency during migration.

Highlights

  • Documentation Update: Updated the mydumper extra-args example configuration in dm/dm-precheck.md to use --consistency auto instead of --consistency none.
  • Configuration Correction: Corrected the mydumper extra-args example in dm/task-configuration-file-full.md to specify --consistency auto for improved data consistency handling.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@JQWong7
Copy link
Copy Markdown
Contributor Author

JQWong7 commented Jul 18, 2025

@kennytm @Oreoxmt PTAL~

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the example configuration for mydumper's extra-args from --consistency none to --consistency auto in two documentation files. The change is straightforward and improves the examples.

My review is based on the provided style guide. I've added a couple of minor suggestions to improve style consistency in the comments by ensuring all parameters are enclosed in backticks, as per the style guide's rule on formatting options (line 34).

Comment thread dm/dm-precheck.md
threads: 4 # The number of threads that access the upstream when the dump processing unit performs the precheck and exports data from the upstream database (4 by default)
chunk-filesize: 64 # The size of the file generated by the dump processing unit (64 MB by default).
extra-args: "--consistency none" # Other arguments of the dump processing unit. You do not need to manually configure table-list in `extra-args`, because it is automatically generated by DM.
extra-args: "--consistency auto" # Other arguments of the dump processing unit. You do not need to manually configure table-list in `extra-args`, because it is automatically generated by DM.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Great update! To maintain consistency with the style guide, let's also wrap the table-list parameter in backticks.1

Style Guide References

Suggested change
extra-args: "--consistency auto" # Other arguments of the dump processing unit. You do not need to manually configure table-list in `extra-args`, because it is automatically generated by DM.
extra-args: "--consistency auto" # Other arguments of the dump processing unit. You do not need to manually configure `table-list` in `extra-args`, because it is automatically generated by DM.

Footnotes

  1. Code snippets, command names, options, and paths should be enclosed in backticks for clarity and consistency. (link)

@Oreoxmt Oreoxmt self-assigned this Jul 18, 2025
@Oreoxmt Oreoxmt added ONCALL Relates to documentation oncall. translation/doing This PR's assignee is translating this PR. labels Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 18, 2025
@Oreoxmt Oreoxmt self-requested a review July 18, 2025 03:59
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 18, 2025
@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Jul 18, 2025

/ok-to-test

@ti-chi-bot ti-chi-bot Bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jul 18, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jul 18, 2025

@kennytm: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@Oreoxmt Oreoxmt added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. translation/doing This PR's assignee is translating this PR. labels Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jul 18, 2025
@Oreoxmt Oreoxmt closed this Jul 18, 2025
@Oreoxmt Oreoxmt reopened this Jul 18, 2025
@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Jul 18, 2025

@River2000i Please sign the CLA at https://cla-assistant.io/pingcap/docs and then I can merge this PR.

@JQWong7
Copy link
Copy Markdown
Contributor Author

JQWong7 commented Jul 18, 2025

@River2000i Please sign the CLA at https://cla-assistant.io/pingcap/docs and then I can merge this PR.

Uploading image.png…

Error
There is no CLA to sign for pingcap/docs

(could not find linked item for owner pingcap and repo docs)

something wrong😢

@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Jul 18, 2025

@River2000i The actual CLA signing link is https://cla.pingcap.net/pingcap/docs?pullRequest=21421, but I see that it's already signed.

@Oreoxmt Oreoxmt added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jul 18, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jul 18, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-07-18 03:59:59.167988813 +0000 UTC m=+2836251.891167795: ☑️ agreed by Oreoxmt.
  • 2025-07-18 08:55:51.946226532 +0000 UTC m=+2854004.669405509: ☑️ agreed by qiancai.

@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Jul 18, 2025

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jul 18, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Jul 18, 2025
@Oreoxmt Oreoxmt added the needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. label Jul 18, 2025
@ti-chi-bot ti-chi-bot Bot merged commit 66262a6 into pingcap:master Jul 18, 2025
14 checks passed
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.1: #21432.

@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #21433.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. ok-to-test Indicates a PR is ready to be tested. ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. 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.

DM: Consider not putting --consistency none in its sample task config

5 participants