Skip to content

add tiflash config storage.temp #21376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+20 −0
Open

add tiflash config storage.temp #21376

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7fd01b
add tiflash config storage.temp
Oreoxmt Jul 10, 2025
556b23a
Apply suggestions from code review
Oreoxmt Jul 18, 2025
6dcd67b
Apply suggestions from code review
Oreoxmt Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tiflash/tiflash-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, it is recommended that you use the [`storage.temp`](#storagetemp-new-in-v900) configuration instead of `tmp_path`, because it supports setting a capacity limit to control temporary file space usage.
- When `storage.temp` is configured, the `tmp_path` configuration does not take effect.

<!-- Example: `"/tidb-data/tiflash-9000/tmp"` -->

Expand Down Expand Up @@ -136,6 +138,24 @@ Configure storage path related settings.

<!-- Example: `[10737418240, 10737418240]` -->

#### storage.temp <span class="version-mark">New in v9.0.0</span>

##### `dir`

- The directory in which the temporary spill files generated during query execution are stored.
- By default, it is the first directory in [`storage.latest.dir`](#dir-1) appended with `"/tmp"`.

##### `capacity`

- Limits the total space usage of the temporary file directory. If the temporary spill files generated during query execution exceed this limit, the query fails with an error.
- Unit: Byte. Formats such as `"10GB"` are not supported.
- Range: `[0, 9223372036854775807]`
- If this value is not set or is 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`.
- This configuration item does not support hot-reloading. You must restart the TiFlash process for changes to take effect.

#### storage.io_rate_limit <span class="version-mark">New in v5.2.0</span>

Configure the I/O traffic limit settings.
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy