Repository navigation
docs: clarify how to disable TiFlash MPP after v7.3 - #24208
doc-claw-bot wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughThe documentation clarifies how to disable MPP while retaining TiFlash Cop or BatchCop execution on TiDB v7.3.0 and later. It also distinguishes this from disabling TiFlash query execution. ChangesTiFlash MPP guidance
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: 🔵 Low · up to Operators may leave TiFlash execution enabled while believing MPP-off disables it. This is a bounded documentation issue with a straightforward correction. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 2 systems. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
c1a9ede3-eada-4e60-9103-df4d59d022a5
📒 Files selected for processing (2)
explore-htap.mdtiflash/use-tiflash-mpp-mode.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.
| set @@session.tidb_allow_tiflash_cop=1; | ||
| ``` | ||
|
|
||
| If you do not need TiFlash to execute queries after disabling the MPP mode, setting only `tidb_allow_mpp=0` is sufficient. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the tidb_allow_mpp=0 requirement.
When tidb_allow_tiflash_cop=ON, disabling MPP still permits Cop and BatchCop plan selection.
If you want to prevent TiFlash from executing queries after disabling the MPP mode, also set `tidb_allow_tiflash_cop=OFF`. If `tidb_allow_tiflash_cop` remains at its default value of `OFF`, setting only `tidb_allow_mpp=0` prevents TiFlash execution.
🧰 Tools
🪛 GitHub Check: vale
[warning] 46-46:
[vale] reported by reviewdog 🐶
[PingCAP.Ambiguous] Consider using a clearer word than 'sufficient' because it may cause confusion.
Raw Output:
{"message":"[PingCAP.Ambiguous] Consider using a clearer word than 'sufficient' because it may cause confusion.","location":{"path":"tiflash/use-tiflash-mpp-mode.md","range":{"start":{"line":46,"column":112},"end":{"line":46,"column":122}}},"severity":"INFO","code":{"value":"PingCAP.Ambiguous"}}
What is changed, added or deleted? (Required)
Clarify the instructions for disabling TiFlash MPP in
explore-htap.mdandtiflash/use-tiflash-mpp-mode.md.For TiDB v7.3.0 and later, if users disable
tidb_allow_mppbut still want TiFlash to execute queries, they also need to enabletidb_allow_tiflash_cop. Otherwise, queries might return errors.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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit
tidb_allow_tiflash_copto use Cop or BatchCop, or settidb_allow_mpp=0alone when TiFlash should not execute queries.