Skip to content

dm: fix filter to filters to match the field name used elsewhere - #23838

Open
yahonda wants to merge 2 commits into
pingcap:release-8.5from
yahonda:fix-en-filter-to-filters
Open

yahonda wants to merge 2 commits into
pingcap:release-8.5from
yahonda:fix-en-filter-to-filters

Conversation

@yahonda

@yahonda yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

"add a `filter` to the task configuration file of DM" uses the singular `filter`, but the field name is `filters` (plural) — as shown in the very next code block in this same file, and documented via the `#### `filters` {#filters}` heading in `dm/task-configuration-file-full.md`.

Source-code verification: `dm/config/task.go` defines the field as `Filters map[string]*bf.BinlogEventRule `yaml:"filters" toml:"filters" json:"filters"`` — confirming `filters` (plural) is the actual field name recognized by DM, in both the YAML task config and its TOML/JSON representations.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Updated the binlog event filtering instructions to reference the correct filters configuration key, matching the accompanying YAML example.

@ti-chi-bot

ti-chi-bot Bot commented Sep 11, 2026

Copy link
Copy Markdown

[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.

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

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 56 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 19d04996-b207-416d-9f6b-b0f9a84db340

📥 Commits

Reviewing files that changed from the base of the PR and between eb3a9d3 and 50a9888.

📒 Files selected for processing (1)
  • filter-binlog-event.md
📝 Walkthrough

Walkthrough

The binlog event filtering documentation now refers to the filters configuration key, matching the YAML example.

Changes

Binlog filter documentation

Layer / File(s) Summary
Update filter configuration instruction
filter-binlog-event.md
Changed the instruction from filter to filters.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: 🔵 Low · up to eb3a9

Users can identify the intended field, but the instruction is ungrammatical. Correcting the wording is a small documentation fix before merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main documentation fix: changing filter to filters to match the documented field name.
Description check ✅ Passed The description explains the change, provides source-code verification, identifies the affected version, and records AI involvement. The related-link fields are empty, but they are not critical for th…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 11, 2026
The task configuration file field is documented as filters (plural)
throughout DM docs, e.g. task-configuration-file-full.md's #### `filters`
heading, and the YAML example immediately following this sentence.
@yahonda
yahonda force-pushed the fix-en-filter-to-filters branch from db8ae05 to eb3a9d3 Compare September 18, 2026 08:34

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: ebdd9e74-f3e6-4439-a451-b910884bc95f

📥 Commits

Reviewing files that changed from the base of the PR and between 9c5b903 and eb3a9d3.

📒 Files selected for processing (1)
  • filter-binlog-event.md

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.

Comment thread filter-binlog-event.md Outdated
Found by CodeRabbit review on PR pingcap#23838.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant