Explain background queries with more details #21466
Conversation
Signed-off-by: Xiaoguang Sun <[email protected]>
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @sunxiaoguang, 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 TiDB Cloud Serverless FAQs by providing a more detailed and comprehensive explanation of various background queries that contribute to Resource Unit (RU) consumption. The update aims to improve user understanding of how RUs are consumed by internal system processes, even when no explicit user queries are being run.
Highlights
- Documentation Clarity: Expanded the explanation of 'background queries' within the TiDB Cloud Serverless FAQs to provide more specific examples of system activities that consume Resource Units (RUs) without direct user-initiated queries.
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 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 or fill out our survey 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.
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. ↩
ti-chi-bot
bot
added
the
size/XS
There was a problem hiding this comment.
Code Review
This pull request provides more detail on background queries that can lead to RU consumption in TiDB Cloud Starter clusters. The change is in the FAQ document. The review focuses on improving the clarity and grammatical correctness of the new text, in line with the documentation style guide. A suggestion is provided to fix a typo and a run-on sentence, which will make the explanation easier for users to understand.
| @@ -102,7 +102,7 @@ This is because TiDB retains dropped tables and databases for a certain period o | |||
|
|
|||
| ### Why are there RU consumptions when I'm not actively running any queries? | |||
|
|
|||
| RU consumptions can occur in various scenarios. One common scenario is during background queries, such as synchronizing schema changes between TiDB instances. Another scenario is when certain web console features generate queries, like loading schemas. These processes use RUs even without explicit user triggers. | |||
| RU consumptions can occur in various scenarios. One common scenario is during background queries, including but not limited to synchronizing schema changes between TiDB instances, executing DDL jobs, refeshing privileges, refreshing SQL bindings, and refreshing global variables. These background jobs consumes Another scenario is when certain web console features generate queries, like loading schemas. These processes use RUs even without explicit user triggers. | |||
There was a problem hiding this comment.
There's a typo: refeshing should be refreshing. Also, the sentence structure is a bit awkward and could be improved for clarity.1
The phrase These background jobs consumes Another scenario is... contains a grammatical error (jobs consumes) and creates a run-on sentence, which affects readability and flow. The final sentence already explains that these processes consume RUs, so the broken phrase is also redundant.
Style Guide References
| RU consumptions can occur in various scenarios. One common scenario is during background queries, including but not limited to synchronizing schema changes between TiDB instances, executing DDL jobs, refeshing privileges, refreshing SQL bindings, and refreshing global variables. These background jobs consumes Another scenario is when certain web console features generate queries, like loading schemas. These processes use RUs even without explicit user triggers. | |
| RU consumptions can occur in various scenarios. One common scenario is during background queries, including but not limited to synchronizing schema changes between TiDB instances, executing DDL jobs, refreshing privileges, refreshing SQL bindings, and refreshing global variables. Another scenario is when certain web console features generate queries, like loading schemas. These processes use RUs even without explicit user triggers. |
Footnotes
It's a minor change to explain background queries with more details. Do not need to cherry pick to release-8.1.
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?