Skip to content

Update dm worker intro #21465

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

alastori
Copy link
Collaborator

@alastori alastori commented Jul 25, 2025

What is changed, added or deleted? (Required)

This PR updates the dm-worker-intro.md document to improve its clarity, accuracy, and completeness.

  • Replaced "Features" with "Key Concepts": The previous "Features" list was inaccurate and confusing. It has been replaced with a "Key Concepts" section that correctly describes the worker's function, including its handling of full and incremental data, its high-availability capabilities, and the "one worker to one source" rule.
  • Added a new Note block: A prominent note was added to clarify that DM-worker is a binlog client, not a standby replica, and to direct users to TiCDC for migrating data from a TiDB cluster.
  • Expanded "Upstream Privileges" section: The original privilege list was insufficient for newer MariaDB versions. The documentation now provides separate, accurate privilege lists and GRANT examples for:
    • MySQL and MariaDB (< 10.5)
    • MariaDB (10.5 and later)
  • Added workaround for MariaDB: A new note explains why the check-task command might fail with MariaDB 10.5+ and provides the ignore-checking-items workaround.

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](https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md#guideline-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)?

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

Copy link

ti-chi-bot bot commented Jul 25, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign overvenus for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

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 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 Jul 25, 2025
Copy link

@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 @alastori, 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 significantly enhances the dm-worker-intro.md documentation by improving its accuracy, clarity, and completeness. It refines the description of DM-worker's core functionalities, clarifies its relationship to other tools like TiCDC, and provides crucial, version-specific updates to upstream database privilege requirements, including a practical workaround for MariaDB 10.5+ compatibility issues.

Highlights

  • Documentation Clarity & Accuracy: The introduction to DM-worker has been significantly revised. The vague 'Features' list was replaced with a more precise 'Key Concepts' section that details its operational role, including full and incremental replication, high-availability aspects, and the 'one worker to one source' rule. This improves the understanding of DM-worker's core functionalities.
  • Role Clarification Note: A prominent note was added to explicitly state that DM-worker is a MySQL binlog client, not a standby replica. This note also guides users to TiCDC for replicating data from a TiDB cluster, preventing common misunderstandings.
  • MariaDB 10.5+ Privilege Updates: The upstream database privilege requirements have been expanded and made version-specific. The documentation now provides distinct and accurate GRANT examples for MySQL/MariaDB (< 10.5) and MariaDB (10.5 and later), addressing changes in MariaDB's privilege system and ensuring correct setup for newer versions.
  • check-task Workaround for MariaDB: A new note and workaround have been added to address potential check-task failures with MariaDB 10.5+. This provides practical guidance on using the ignore-checking-items option in task configurations when encountering privilege errors, improving user experience.
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 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 or fill out our survey 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.

@alastori
Copy link
Collaborator Author

cc @OliverS929

Copy link

@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 is a great update that significantly improves the accuracy and clarity of the DM-worker documentation. The restructuring of the privileges section to account for different MariaDB versions is particularly helpful. I've added a few minor suggestions to enhance readability and correct some markdown formatting. Overall, excellent work!

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant