Update system-variables.md #50
Conversation
Summary of ChangesHello @qiancai, 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, despite its title suggesting an update to Highlights
Using Gemini Code AssistThe 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
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 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
|
Synced from: qiancai/docs-cn#15 Target PR: #50 AI Provider: gemini Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
|
🤖 Auto-sync completed successfully 📥 Source PR: qiancai/docs-cn#15 This comment was generated automatically by the sync workflow. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new file, temp.md, which appears to be a test file. There is a discrepancy between the file changes and the pull request's title and description, which refer to updates for system-variables.md. For clarity, please consider aligning the PR's metadata with its content. My review is based on the provided file change, and I have one minor suggestion to adhere to common file formatting conventions.
WalkthroughA new system variable Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
system-variables.md (1)
1796-1803: Align attribute list with house style.Please match the field labels and value formatting used by other variables (for example
tidb_default_string_match_selectivity) so the table stays consistent and scannable: “Persists to cluster: …”, “Applies to hint …”, “Type: Float”, “Range: …” etc. The current mix of sentence casing and wording breaks the established pattern and makes the entry harder to read. Suggested edit:- Is persisted to the cluster: Yes - Is controlled by the Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes - Type: Floating-point number - Value range: `[0, 1]` + - Persists to cluster: Yes + - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes + - Type: Float + - Range: `[0, 1]`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
system-variables.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
⚙️ CodeRabbit configuration file
As a technical writer in the database area, you need to first learn the changes in this PR, and then improve the content to make it clear, concise, and easy to understand in English according to your database knowledge.
Files:
system-variables.md
|
/gemini review |
There was a problem hiding this comment.
Code Review
The pull request adds documentation for the tidb_opt_selectivity_factor system variable, which is introduced in v9.0.0. The variable is of float type, available in SESSION and GLOBAL scope, accepts values in the range [0, 1], and has a default value of 0.8. The documentation also states that it is not recommended to modify this value. I have provided a suggestion to improve the clarity of the documentation.
| - Type: Floating-point number | ||
| - Value range: `[0, 1]` | ||
| - Default value: `0.8` | ||
| - This variable is used to specify the default selectivity of the TiDB optimizer. In some cases, when the optimizer cannot derive the predicate selectivity based on statistics, the optimizer uses this default selectivity as an alternative value. **It is not recommended** to modify this value. |
There was a problem hiding this comment.
To improve clarity, consider rephrasing this sentence to emphasize the potential negative consequences of modifying this variable. For example: "Modifying this value is strongly discouraged as it can significantly impact query optimization and performance."
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 (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?
Summary by CodeRabbit
tidb_opt_selectivity_factorsystem variable (v9.0.0+). This float-type variable, available in SESSION and GLOBAL scope, accepts values in range [0, 1] with a default of 0.8.