stale read: update the description of tidb_external_ts (#20667) #20730
Conversation
ti-chi-bot
added
lgtm
needs-1-more-lgtm
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
This pull request updates the description of tidb_external_ts in the stale-read.md documentation file. It adds tidb_enable_external_ts_read to the description, indicating that both system variables are used to specify an exact point in time for stale reads at the session or global level.
Highlights
- Documentation Update: The description of
tidb_external_tsis updated to includetidb_enable_external_ts_read, clarifying the usage of both variables for stale reads. - Stale Read: The documentation now accurately reflects the requirement of using both
tidb_external_tsandtidb_enable_external_ts_readfor specifying an exact point in time for stale reads.
Changelog
- stale-read.md
- Updated the description of
tidb_external_tsto includetidb_enable_external_ts_read. - Clarified that both
tidb_external_tsandtidb_enable_external_ts_readare needed to specify an exact point in time for stale reads.
- Updated the description of
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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.
A doc's gentle hand,
Guides readers through the stale land,
With variables paired,
No longer ensnared,
In time's shifting, uncertain sand.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
The pull request updates the description of the tidb_external_ts system variable in stale-read.md to include tidb_enable_external_ts_read. This change ensures that users are aware of both variables required for specifying an exact point in time for stale reads. The change is straightforward and improves the documentation.
Summary of Findings
- Completeness of Description: The description update is necessary to ensure users understand the complete process of specifying an exact point in time for stale reads using
tidb_external_tsandtidb_enable_external_ts_read.
Merge Readiness
The pull request is ready for merging. The change is clear and directly addresses the issue of an incomplete description for using tidb_external_ts. There are no identified issues that would prevent merging. However, as always, it's important to have others review and approve this code before merging, as I am unable to approve the pull request.
| @@ -35,7 +35,7 @@ TiDB provides the methods of performing Stale Read at the statement level, the s | |||
| - Session level | |||
| - Specifying a time range: In a session, if you need TiDB to read the data as new as possible within a time range in subsequent queries without violating the isolation level, you can specify the time range by setting the `tidb_read_staleness` system variable. For detailed usage, refer to [`tidb_read_staleness`](/tidb-read-staleness.md). | |||
|
|
|||
| Besides, TiDB provides a way to specify an exact point in time by setting the [`tidb_external_ts`](/system-variables.md#tidb_external_ts-new-in-v640) system variable on session or global level. For detailed usage, refer to [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md). | |||
| Besides, TiDB provides a way to specify an exact point in time at the session or global level by setting the [`tidb_external_ts`](/system-variables.md#tidb_external_ts-new-in-v640) and [`tidb_enable_external_ts_read`](/system-variables.md#tidb_enable_external_ts_read-new-in-v640) system variables. For detailed usage, refer to [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md). | |||
There was a problem hiding this comment.
Consider rephrasing to improve readability. Suggestion: "Besides, TiDB provides a way to specify an exact point in time at the session or global level by setting both the tidb_external_ts and tidb_enable_external_ts_read system variables."
| Besides, TiDB provides a way to specify an exact point in time at the session or global level by setting the [`tidb_external_ts`](/system-variables.md#tidb_external_ts-new-in-v640) and [`tidb_enable_external_ts_read`](/system-variables.md#tidb_enable_external_ts_read-new-in-v640) system variables. For detailed usage, refer to [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md). | |
| Besides, TiDB provides a way to specify an exact point in time at the session or global level by setting both the [`tidb_external_ts`](/system-variables.md#tidb_external_ts-new-in-v640) and [`tidb_enable_external_ts_read`](/system-variables.md#tidb_enable_external_ts_read-new-in-v640) system variables. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
This is an automated cherry-pick of #20667
What is changed, added or deleted? (Required)
close #20611
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)?
Do your changes match any of the following descriptions?