diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index 0ba3b83c37c67..ee2e6b2cf01c4 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -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. @@ -136,6 +138,24 @@ Configure storage path related settings. +#### storage.temp New in v9.0.0 + +##### `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 New in v5.2.0 Configure the I/O traffic limit settings.