Skip to content

Clarify TiKV large-row limit in transaction restraints#23338

Open
doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/txn-raft-entry-limit
Open

Clarify TiKV large-row limit in transaction restraints#23338
doc-claw-bot wants to merge 1 commit into
pingcap:masterfrom
doc-claw-bot:docs/txn-raft-entry-limit

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Clarify in develop/dev-guide-transaction-restraints.md that increasing the TiDB large-row limit alone is not enough. When a single write request exceeds TiKV raftstore.raft-entry-max-size, TiKV rejects the request, so users need to adjust the TiKV limit together with the TiDB row-size limit.

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.

  • master (the latest development version)
  • 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)
  • v5.3 (TiDB 5.3 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

Summary by CodeRabbit

  • Documentation
    • Clarified large transaction restrictions by documenting TiKV’s per-request write-size limit.
    • Noted that large-row workloads may require coordinating TiDB and TiKV size settings.

@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. contribution This PR is from a community contributor. labels Jul 22, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 22, 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 ran-huang 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 Jul 22, 2026
@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. labels Jul 22, 2026
@ti-chi-bot ti-chi-bot Bot removed missing-translation-status This PR does not have translation status info. labels Jul 22, 2026
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The transaction restrictions guide now notes TiKV’s per-write request limit, its default 8 MiB raftstore.raft-entry-max-size setting, and the need to adjust TiDB and TiKV limits together for large rows.

Changes

Transaction size documentation

Layer / File(s) Summary
TiKV write request limit
develop/dev-guide-transaction-restraints.md
Adds guidance that TiKV rejects single write requests exceeding raftstore.raft-entry-max-size, which defaults to 8 MiB, and that large-row workloads may require changing both TiDB and TiKV limits.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly and concisely reflects the main documentation change about TiKV's large-row limit.
Description check ✅ Passed Includes the required change summary, affected versions, references, and branch-modification note; only optional items are omitted.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@qiancai qiancai added needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. and removed needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. labels Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. contribution This PR is from a community contributor. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-8.1 Should cherry pick this PR to release-8.1 branch. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants