Skip to content

Clarify TiKV large-row limit in transaction restraints (#23338) (#23348)#23351

Open
ti-chi-bot wants to merge 1 commit into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23348-to-master
Open

Clarify TiKV large-row limit in transaction restraints (#23338) (#23348)#23351
ti-chi-bot wants to merge 1 commit into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23348-to-master

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Jul 23, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23348

This is an automated cherry-pick of #23338

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 configuration guidance for large transaction rows.
    • Explained that TiDB’s tidb_txn_entry_size_limit and TiKV’s raftstore.raft-entry-max-size should be adjusted together.
    • Preserved the existing parameter names and size limits.

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot added area/develop This PR relates to the area of TiDB App development. contribution This PR is from a community contributor. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Jul 23, 2026
@ti-chi-bot ti-chi-bot self-assigned this Jul 23, 2026
@ti-chi-bot

Copy link
Copy Markdown
Member Author

@ti-chi-bot This PR has conflicts, I have hold it.
Please resolve them or ask others to resolve them, then comment /unhold to remove the hold label.

@ti-chi-bot

ti-chi-bot Bot commented Jul 23, 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 oreoxmt 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 commented Jul 23, 2026

Copy link
Copy Markdown

@ti-chi-bot: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 6360049 link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The transaction restrictions guide clarifies that large-row handling requires adjusting TiDB’s tidb_txn_entry_size_limit together with TiKV’s raftstore.raft-entry-max-size, while retaining the existing 8 MiB threshold.

Changes

Transaction restrictions documentation

Layer / File(s) Summary
Clarify TiDB and TiKV configuration pairing
develop/dev-guide-transaction-restraints.md
Updates the large transaction restrictions note to distinguish the TiDB and TiKV settings for oversized single write requests.

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

Possibly related PRs

Suggested labels: translation/done, translation/from-docs-cn, needs-cherry-pick-release-8.1

Suggested reviewers: doc-claw-bot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: clarifying TiKV large-row limits in transaction restraints.
Description check ✅ Passed The description includes the change summary, affected versions, and reference links, matching the required template closely.
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.
✨ 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.

@ti-chi-bot

ti-chi-bot Bot commented Jul 23, 2026

Copy link
Copy Markdown

@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@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: Pro Plus

Run ID: f1b24695-eb3a-4031-bc3b-a57b66b5f98c

📥 Commits

Reviewing files that changed from the base of the PR and between caed46d and 6360049.

📒 Files selected for processing (1)
  • develop/dev-guide-transaction-restraints.md

Comment on lines +717 to +721
<<<<<<< HEAD
- Note that TiKV also limits the data size of a single write request. If the data size of a single write request exceeds [`raftstore.raft-entry-max-size`](/tikv-configuration-file.md#raft-entry-max-size), which is `8 MiB` by default, TiKV rejects the request. When a single row is large, you need to adjust both `tidb_txn_entry_size_limit` in TiDB and `raftstore.raft-entry-max-size` in TiKV.
=======
- Note that TiKV also limits the data size of a single write request. If the data size of a single write request exceeds [`raftstore.raft-entry-max-size`](/tikv-configuration-file.md#raft-entry-max-size), which is `8 MiB` by default, TiKV rejects the request. When a single row is large, you need to adjust both `tidb_txn_entry_size_limit` for TiDB and `raftstore.raft-entry-max-size` for TiKV.
>>>>>>> 499c12a01f (Clarify TiKV large-row limit in transaction restraints (#23338) (#23348))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

Resolve the merge conflict and preserve version-specific TiDB settings.

These lines contain committed conflict markers and duplicate content. They also direct pre-v7.6 users to tidb_txn_entry_size_limit, which is unavailable before v7.6.0; those versions use performance.txn-entry-size-limit.

Suggested change
<<<<<<< HEAD
- Note that TiKV also limits the data size of a single write request. If the data size of a single write request exceeds [`raftstore.raft-entry-max-size`](/tikv-configuration-file.md#raft-entry-max-size), which is `8 MiB` by default, TiKV rejects the request. When a single row is large, you need to adjust both `tidb_txn_entry_size_limit` in TiDB and `raftstore.raft-entry-max-size` in TiKV.
=======
- Note that TiKV also limits the data size of a single write request. If the data size of a single write request exceeds [`raftstore.raft-entry-max-size`](/tikv-configuration-file.md#raft-entry-max-size), which is `8 MiB` by default, TiKV rejects the request. When a single row is large, you need to adjust both `tidb_txn_entry_size_limit` for TiDB and `raftstore.raft-entry-max-size` for TiKV.
>>>>>>> 499c12a01f (Clarify TiKV large-row limit in transaction restraints (#23338) (#23348))
- Note that TiKV also limits the data size of a single write request. If the data size of a single write request exceeds [`raftstore.raft-entry-max-size`](/tikv-configuration-file.md#raft-entry-max-size), which is `8 MiB` by default, TiKV rejects the request. When a single row is large, you need to adjust both the TiDB row-size limit (`performance.txn-entry-size-limit`, or `tidb_txn_entry_size_limit` starting from v7.6.0) and `raftstore.raft-entry-max-size` in TiKV.

As per path instructions, use a committable suggestion for this contiguous Markdown fix.

Sources: Coding guidelines, Path instructions

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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant