Skip to content

docs: fix illogical wording for HASH/KEY partitioned tables and DROP PARTITION - #23892

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-drop-partition-wording
Open

yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-drop-partition-wording

Conversation

@yahonda

@yahonda yahonda commented Sep 16, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

best-practices/tidb-partitioned-tables-best-practices.md said:

Although global indexes can slow down `DROP PARTITION` operations, Hash and Key partitioned tables do not support `DROP PARTITION`. Therefore, global indexes are a practical solution because these partitions are rarely truncated.

This is self-contradictory: Hash and Key partitioned tables don't support `DROP PARTITION` at all (a hard constraint), so framing it as "these partitions are rarely truncated" misstates a total lack of support as a matter of low frequency. Reworded to state that the DROP-PARTITION performance trade-off simply doesn't apply to these tables, since the operation isn't available on them.

Found while reviewing the Japanese translation of this file (which faithfully mirrored this EN wording) — flagged by a CodeRabbit review on the JA PR.

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

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated partitioned-table guidance to clarify that Hash and Key partitioning do not support dropping partitions, so related global-index considerations do not apply.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: e6262bf5-83eb-42e8-94d7-c6d8a917b371

📥 Commits

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

📒 Files selected for processing (1)
  • best-practices/tidb-partitioned-tables-best-practices.md

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


📝 Walkthrough

Walkthrough

Changes

Partitioned table guidance

Layer / File(s) Summary
Drop partition limitation
best-practices/tidb-partitioned-tables-best-practices.md
The guidance states that Hash and Key partitioned tables do not support DROP PARTITION. It removes the statement that these partitions are rarely truncated.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 3fe99

The documentation accurately clarifies the supported partition operations without changing runtime behavior.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation wording fix for HASH/KEY partitioned tables and DROP PARTITION. It is concise and directly reflects the main change.
Description check ✅ Passed The description explains the wording problem, the correction, the affected file, the applicable TiDB version, the related review link, and AI involvement. The required sections are substantially compl…
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 commented Sep 16, 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 csuzhangxc 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 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 16, 2026
…ed tables

Hash and Key partitioned tables do not support DROP PARTITION at all,
so framing this as "these partitions are rarely truncated" misstates
the limitation as a matter of frequency rather than a hard
unsupported-operation constraint. Reworded to state the trade-off
does not apply to these tables, rather than implying dropping is just
uncommon.

Found while reviewing the Japanese translation of this file, which
faithfully mirrored this EN wording; flagged by a CodeRabbit review on
the JA translation PR.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the fix-drop-partition-wording branch from 44345a6 to 3fe9938 Compare September 18, 2026 08:33
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