Skip to content

Clarify --sql behavior in Dumpling CSV export docs - #21988

Open
doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/fix-dumpling-sql-wording
Open

doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/fix-dumpling-sql-wording

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

What is changed, added, or deleted? (Required)

Clarify that --sql runs the SQL statement you provide directly when exporting CSV files. This removes the misleading wording that implied Dumpling executes the example statement on every table to be exported.

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 (in Chinese).

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

What is the related PR or file 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

  • 文档
    • 更新 CSV 导出中 --sql 参数的说明:现在将直接执行指定的 SQL 语句。
    • 使用不存在的列时,导出操作将失败。

@ti-chi-bot

ti-chi-bot Bot commented Oct 21, 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 lance6716 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

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. labels Oct 21, 2026
@doc-claw-bot doc-claw-bot added translation/from-docs This PR is translated from a PR in pingcap/docs. type/bugfix This PR fixes a bug. area/br Indicates that the Issue or PR belongs to the area of BR (Backup & Restore). labels Oct 21, 2026
@ti-chi-bot ti-chi-bot Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed missing-translation-status This PR does not have translation status info. labels Oct 21, 2026
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs-cn/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 2fb6dfc2-5388-440c-8222-961a6de6026e
📥 Commits

Reviewing files that changed from the base of the PR and between 8860d46 and 3208a1b.

📒 Files selected for processing: 1
  • dumpling-overview.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

更新了 Dumpling 文档中 --sql 的行为说明:Dumpling 直接执行指定的 SQL;如果 SQL 引用不存在的列,导出会失败。

Changes: Dumpling SQL 导出说明

层 / 文件 摘要
更新 SQL 行为说明
dumpling-overview.md
文档将 --sql 的说明改为直接执行指定的 SQL,并说明引用不存在的列时导出会失败。

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: ⚪ Minimal · up to 3208a

No actionable implementation risk remains; the documentation change is mergeable.

Architecture risk: 🔵 Low · up to 3208a

The change affects 1 system.

Changed systems: dumpling-overview.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — dumpling-overview.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in dumpling-overview.md: --sql 的行为说明从对所有待导出表生成查询改为直接执行用户指定的 SQL;若 SQL 引用不存在的列,导出失败。
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed 标题准确概括了主要变更,即澄清 Dumpling CSV 导出中 --sql 的行为。标题简洁且与变更内容一致。
Description check Passed 描述包含必需的变更说明和适用版本信息,并提供了相关 PR、文档和代码链接。master 版本已勾选,内容与 PR 目标一致。
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.
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

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

Labels

area/br Indicates that the Issue or PR belongs to the area of BR (Backup & Restore). contribution This PR is from a community contributor. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant