From 291d3fbb502be978470272ea05a2805f97c9a7fe Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 21 Apr 2020 20:57:00 +0800 Subject: [PATCH] reference: add a new config in tidb-server config doc (#2287) --- reference/configuration/tidb-server/configuration-file.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/reference/configuration/tidb-server/configuration-file.md b/reference/configuration/tidb-server/configuration-file.md index eeff48d58f027..e0be52cf1f195 100644 --- a/reference/configuration/tidb-server/configuration-file.md +++ b/reference/configuration/tidb-server/configuration-file.md @@ -34,6 +34,14 @@ The TiDB configuration file supports more options than command-line parameters. + Default value: `/tidb/tmp-storage` + It only takes effect when `oom-use-tmp-storage` is `true`. +### `tmp-storage-quota` + ++ Specifies the quota for the storage in `tmp-storage-path`. The unit is byte. ++ When a single SQL statement uses a temporary disk and the total volume of the temporary disk of the TiDB server exceeds this configuration value, the current SQL operation is cancelled and the `Out of Global Storage Quota!` error is returned. ++ When the value of this configuration is smaller than `0`, the above check and limit do not apply. ++ Default value: `-1` ++ When the remaining available storage in `tmp-storage-path` is lower than the value defined by `tmp-storage-quota`, the TiDB server reports an error when it is started, and exits. + ### `oom-action` - Specifies what operation TiDB performs when a single SQL statement exceeds the memory quota specified by `mem-quota-query` and cannot be spilled over to disk.