add tiflash config storage.temp #21376
Conversation
Oreoxmt
added
translation/from-docs-cn
|
[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
size/S
![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 @Oreoxmt, 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 updates the TiFlash configuration documentation to introduce a new, more robust method for managing temporary files. It deprecates an older configuration (tmp_path) in favor of storage.temp, which allows for explicit capacity limits on temporary file storage, improving resource management and preventing uncontrolled disk usage by temporary data generated during query execution.
Highlights
- New TiFlash Temporary Storage Configuration: Introduced
storage.tempas a new configuration option for TiFlash, starting from v9.0.0. This new configuration provides more granular control over temporary file storage, including the ability to set capacity limits. - Deprecation of
tmp_path: The existingtmp_pathconfiguration is now deprecated and its use is not recommended from v9.0.0. The documentation explicitly states thattmp_pathwill be ignored ifstorage.tempis configured. storage.tempSub-options: Detailed documentation forstorage.tempincludesdirto specify the temporary file path (defaulting to the first directory instorage.latest.dirappended with/tmp) andcapacityto limit the total space usage of temporary files. Thecapacityoption includes details on its unit (Byte), range, default behavior (no limit if 0 or unset), and startup validation checks.
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.
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
This pull request adds documentation for the new storage.temp configuration in TiFlash and updates the related tmp_path parameter. The changes are well-written and informative. I've provided a few minor suggestions to enhance clarity and conciseness, in line with the repository's style guide. I have referenced the style guide where applicable.
| - If this value is not set or set to `0`, temporary files are not subject to a space limit and can use the entire disk capacity. | ||
| - If a value greater than `0` is set, TiFlash performs the following checks at startup: | ||
| - `storage.temp.capacity` must be less than or equal to the total space of the disk where `storage.temp.dir` is located. | ||
| - If `storage.temp.dir` is a subdirectory of `storage.main.dir` and `storage.main.capacity` is greater than `0`, then `storage.temp.capacity` must be less than or equal to `storage.main.capacity`. The same check applies if it is a subdirectory of `storage.latest.dir`. |
There was a problem hiding this comment.
This sentence is slightly ambiguous. To make it clearer, explicitly mention what storage.temp.dir is checked against when it is a subdirectory of storage.latest.dir.1
Style Guide References
| - If `storage.temp.dir` is a subdirectory of `storage.main.dir` and `storage.main.capacity` is greater than `0`, then `storage.temp.capacity` must be less than or equal to `storage.main.capacity`. The same check applies if it is a subdirectory of `storage.latest.dir`. | |
| - If `storage.temp.dir` is a subdirectory of `storage.main.dir` and `storage.main.capacity` is greater than `0`, then `storage.temp.capacity` must be less than or equal to `storage.main.capacity`. The same check applies if `storage.temp.dir` is a subdirectory of `storage.latest.dir` (in which case `storage.temp.capacity` is checked against `storage.latest.capacity`). |
Footnotes
| @@ -87,6 +87,8 @@ This section introduces the configuration parameters of TiFlash. | |||
|
|
|||
| - The path in which the TiFlash temporary files are stored. | |||
| - By default, it is the first directory in [`path`](#path) or in [`storage.latest.dir`](#dir-1) appended with `"/tmp"`. | |||
| - Starting from v9.0.0, using `tmp_path` is not recommended. It is recommended to use the [`storage.temp`](#storage.temp-new-in-v900) configuration instead, which supports capacity limits to control temporary file space usage. | |||
There was a problem hiding this comment.
To improve conciseness and adhere to the style guide's preference for the second person ("you"), rephrase this sentence.1
Style Guide References
| - Starting from v9.0.0, using `tmp_path` is not recommended. It is recommended to use the [`storage.temp`](#storage.temp-new-in-v900) configuration instead, which supports capacity limits to control temporary file space usage. | |
| - Starting from v9.0.0, it is recommended that you use the [`storage.temp`](#storage.temp-new-in-v900) configuration instead of `tmp_path`, as it supports capacity limits to control temporary file space usage. |
Footnotes
|
|
||
| ##### `dir` | ||
|
|
||
| - The path in which the temporary spill files generated during queries are stored. |
There was a problem hiding this comment.
For better readability, simplify "in which" to "where".1
Style Guide References
| - The path in which the temporary spill files generated during queries are stored. | |
| - The path where the temporary spill files generated during queries are stored. |
Footnotes
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?