cloud: document TiDB X foreign key shared locks and lock upgrades - #23479
cloud: document TiDB X foreign key shared locks and lock upgrades#23479wfxr wants to merge 3 commits into
Conversation
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
the
do-not-merge/work-in-progress
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe documentation clarifies shared-lock promotion and upgrade behavior. It adds the experimental TiDB X configuration for shared-lock foreign key checks, including prerequisites, persisted-value behavior, transaction limitations, and warnings. ChangesForeign Key Shared-Lock Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: 🔵 Low · up to The documentation currently does not state that shared-lock upgrade is limited to TiDB X and unsupported in aggressive or fair locking modes, which could mislead users configuring foreign-key checks. The PR is mergeable with explicit owner follow-up to add those constraints. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation 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. (3 skipped: 3 unsupported.) Full details: Description checkExplanation The description is mostly complete and explains the scope, behavior, limitations, related PRs, AI involvement, and branch-specific follow-up. The v8.5 checkbox is not selected even though the description states that the PR targets release-8.5. ✨ 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 |
|
/label version-specific-changes-required |
ti-chi-bot
Bot
added
the
missing-translation-status
|
@wfxr: The label(s) DetailsIn response to this:
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. |
|
|
ti-chi-bot
Bot
added
the
size/S
|
/label requires-version-specific-changes |
ti-chi-bot
Bot
added
the
requires-version-specific-changes
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
|
/hold |
ti-chi-bot
Bot
added
the
do-not-merge/hold
Add the experimental TiDB X configuration and clarify the system variable prerequisite. Document how persisted or restored ON values behave across upgrades.
e9b2967 to
f278fd0
Compare
|
[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 |
ti-chi-bot
Bot
added
size/M
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Team
Run ID: e964db16-00b9-49ef-909a-34fb22479bae
📒 Files selected for processing (3)
foreign-key.mdsystem-variables.mdtidb-configuration-file.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
wfxr
changed the title
2 participants
What is changed, added or deleted? (Required)
Document the experimental controls and limitations for using shared locks during foreign key checks on TiDB X.
NOTE
This change applies only to TiDB X deployments used by TiDB Cloud Premium and Essential v2. It does not apply to TiDB Self-Managed (OP) or other classic TiDB deployments. The shared lock features are experimental and have not reached general availability (GA).
[experimental].allow-enable-foreign-key-check-in-shared-lockto be enabled before SQL users can settidb_foreign_key_check_in_shared_locktoON.ONvalue that has already been persisted or restored.tidb_enable_shared_lock_upgradefor pessimistic transactions that update or delete a parent row after acquiring a shared lock on that row during a foreign key check.tidb_enable_shared_lock_promotionand document shared lock limitations for aggressive locking mode, fair locking mode, one-phase commit, and Async Commit.The foreign-key shared-lock gate changes were merged into TiDB
master, while the shared lock upgrade change is tracked in pingcap/tidb#69559. This documentation PR targetsrelease-8.5, which is the source branch for the current TiDB Cloud documentation. The documentation team can decide whether to apply the change to docsmasterduring review.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