Skip to content

Conversation

@King-Dylan
Copy link
Member

@King-Dylan King-Dylan commented Dec 11, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

Close issue 22169
Currently, the official docs say these modes will try leader and follower replicas only.

However, from the KV client implementation:

  • leader-and-follower, closest-replicas, and closest-adaptive are classified as ReplicaReadMixed
  • ReplicaReadMixed will also attempt to read from learner replicas

This causes a behavior–documentation mismatch. Users who rely on the docs may assume that learners are never used under these modes, which can be surprising, especially when they deploy read-only / learner-only nodes.

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)
  • v9.0 (TiDB 9.0 versions)
  • 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)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference 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

@ti-chi-bot
Copy link

ti-chi-bot bot commented Dec 11, 2025

[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 qiancai 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.

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 the missing-translation-status This PR does not have translation status info. label Dec 11, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @King-Dylan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the accuracy of the TiDB documentation by clarifying the behavior of the tidb_replica_read system variable. Specifically, it updates the descriptions for the leader-and-follower and closest-replicas read modes to explicitly mention that learner replicas are also utilized for read operations, providing a more complete and precise understanding for users configuring replica read policies.

Highlights

  • Documentation Clarity for Replica Read Modes: The documentation for the tidb_replica_read system variable has been updated to explicitly state that the leader-and-follower mode also considers learner replicas for read operations, ensuring a more accurate description of the system's behavior.
  • Inclusion of Learner Replicas in Closest Replicas Mode: The description for the tidb_replica_read setting when set to closest-replicas has been clarified to include learner replicas as potential candidates for read operations within the same availability zone.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Dec 11, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request clarifies that learner replicas are also considered for read operations when tidb_replica_read is set to leader-and-follower or closest-replicas. The changes are accurate and improve the documentation. I've added a couple of suggestions to improve conciseness and maintain a consistent voice throughout the list, in line with the documentation style guide.

@King-Dylan King-Dylan changed the title docs: clarify ReplicaReadMixed also uses learner replicas Clarify ReplicaReadMixed also uses learner replicas Dec 11, 2025
@hfxsd hfxsd requested a review from you06 December 12, 2025 04:14
@hfxsd hfxsd self-assigned this Dec 12, 2025
@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ReplicaReadMixed in leader-and-follower / closest-replicas / closest-adaptive also tries learner replicas but docs say only leader & follower

2 participants