docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify ReplicaReadMixed also uses learner replicas

Open King-Dylan opened this issue 2 weeks ago • 2 comments

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.

  • [x] master (the latest development version)
  • [x] v9.0 (TiDB 9.0 versions)
  • [x] v8.5 (TiDB 8.5 versions)
  • [x] v8.1 (TiDB 8.1 versions)
  • [x] v7.5 (TiDB 7.5 versions)
  • [x] v7.1 (TiDB 7.1 versions)
  • [x] 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

King-Dylan avatar Dec 11 '25 18:12 King-Dylan

Summary of Changes

Hello @King-Dylan, I'm Gemini Code Assist[^1]! 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 :thumbsup: and :thumbsdown: 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.

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

gemini-code-assist[bot] avatar Dec 11 '25 18:12 gemini-code-assist[bot]

@you06: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In 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 kubernetes-sigs/prow repository.

ti-chi-bot[bot] avatar Dec 15 '25 09:12 ti-chi-bot[bot]

[LGTM Timeline notifier]

Timeline:

  • 2025-12-15 09:09:53.209560533 +0000 UTC m=+1464138.023338095: :ballot_box_with_check: agreed by hfxsd.

ti-chi-bot[bot] avatar Dec 15 '25 09:12 ti-chi-bot[bot]

/approve

hfxsd avatar Dec 15 '25 09:12 hfxsd

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

The full list of commands accepted by this bot can be found here.

The pull request process is described 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[bot] avatar Dec 15 '25 09:12 ti-chi-bot[bot]

In response to a cherrypick label: new pull request created to branch release-7.1: #22182. But this PR has conflicts, please resolve them!

ti-chi-bot avatar Dec 15 '25 09:12 ti-chi-bot

In response to a cherrypick label: new pull request created to branch release-7.5: #22183.

ti-chi-bot avatar Dec 15 '25 09:12 ti-chi-bot

In response to a cherrypick label: new pull request created to branch release-8.1: #22184.

ti-chi-bot avatar Dec 15 '25 09:12 ti-chi-bot

In response to a cherrypick label: new pull request created to branch release-8.5: #22185.

ti-chi-bot avatar Dec 15 '25 09:12 ti-chi-bot