From 24268f6231a73ba70d10ebac0800c09a59b30632 Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 13 Sep 2022 21:58:47 +0800 Subject: [PATCH 1/3] add instruction for editing config Signed-off-by: Ran --- pd-configuration-file.md | 6 +++++- tidb-configuration-file.md | 4 ++++ tiflash/tiflash-configuration.md | 4 ++++ tikv-configuration-file.md | 4 ++++ 4 files changed, 17 insertions(+), 1 deletion(-) diff --git a/pd-configuration-file.md b/pd-configuration-file.md index 2f7b27f20b51..c82729c3172b 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -11,6 +11,10 @@ PD 配置文件比命令行参数支持更多的选项。你可以在 [conf/conf 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### `name` + PD 节点名称。 @@ -270,7 +274,7 @@ PD 配置文件比命令行参数支持更多的选项。你可以在 [conf/conf + 设置是否开启跨表 merge。 + 默认值：true -### `region-score-formula-version` 从 v5.0 版本开始引入 +### `region-score-formula-version` 从 v5.0 版本开始引入 + 设置 Region 算分公式版本。 + 默认值：v2 diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index ba7ec89e4c04..0de10cf0d750 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -9,6 +9,10 @@ aliases: ['/docs-cn/dev/tidb-configuration-file/','/docs-cn/dev/reference/config TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### `split-table` + 为每个 table 建立单独的 Region。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index f9cfd0916ea3..10e0f8c2119e 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -29,6 +29,10 @@ aliases: ['/docs-cn/dev/tiflash/tiflash-configuration/','/docs-cn/dev/reference/ ## TiFlash 配置参数 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### 配置文件 tiflash.toml ```toml diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index d1876f84e7cf..afc53e642042 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -9,6 +9,10 @@ TiKV 配置文件比命令行参数支持更多的选项。你可以在 [etc/con 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [TiKV 配置参数](/command-line-flags-for-tikv-configuration.md)。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ## 全局配置 From 302e8868f12dcb2d1680d6f652f531d6dc097bdb Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 13 Sep 2022 21:58:47 +0800 Subject: [PATCH 2/3] add instruction for editing config Signed-off-by: Ran --- pd-configuration-file.md | 6 +++++- tidb-configuration-file.md | 4 ++++ tiflash/tiflash-configuration.md | 4 ++++ tikv-configuration-file.md | 6 ++++++ 4 files changed, 19 insertions(+), 1 deletion(-) diff --git a/pd-configuration-file.md b/pd-configuration-file.md index b57fee33774e..aa59a33738b0 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -11,6 +11,10 @@ PD 配置文件比命令行参数支持更多的选项。你可以在 [conf/conf 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### `name` + PD 节点名称。 @@ -333,7 +337,7 @@ pd-server 相关配置项。 + 设置是否开启跨表 merge。 + 默认值：true -### `region-score-formula-version` 从 v5.0 版本开始引入 +### `region-score-formula-version` 从 v5.0 版本开始引入 + 设置 Region 算分公式版本。 + 默认值：v2 diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index daa95c79790f..bc6d10a3ed72 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -9,6 +9,10 @@ aliases: ['/docs-cn/dev/tidb-configuration-file/','/docs-cn/dev/reference/config TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### `split-table` + 为每个 table 建立单独的 Region。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index e459ba2a8067..fc7edec1e0af 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -29,6 +29,10 @@ aliases: ['/docs-cn/dev/tiflash/tiflash-configuration/','/docs-cn/dev/reference/ ## TiFlash 配置参数 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + ### 配置文件 tiflash.toml ```toml diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index fd2f651a3a8f..b7eeccedbdf0 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -12,6 +12,12 @@ TiKV 配置文件比命令行参数支持更多的选项。你可以在 [etc/con 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [TiKV 配置参数](/command-line-flags-for-tikv-configuration.md)。 + +如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 + + + + ## 全局配置 ### `abort-on-panic` From 3de1450a6d07e75fdeb901d516dc36e48880777f Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 2 Mar 2023 12:00:01 +0800 Subject: [PATCH 3/3] update tip Signed-off-by: Ran --- pd-configuration-file.md | 6 +++--- tidb-configuration-file.md | 8 ++++---- tiflash/tiflash-configuration.md | 8 ++++---- tikv-configuration-file.md | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/pd-configuration-file.md b/pd-configuration-file.md index aa59a33738b0..afb7378af7c9 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -11,9 +11,9 @@ PD 配置文件比命令行参数支持更多的选项。你可以在 [conf/conf 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [PD 配置参数](/command-line-flags-for-pd-configuration.md)。 - -如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 - +> **Tip:** +> +> 如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 ### `name` diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index bc6d10a3ed72..1bfa0f5c73bb 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -9,9 +9,9 @@ aliases: ['/docs-cn/dev/tidb-configuration-file/','/docs-cn/dev/reference/config TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/config.toml.example](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) 找到默认值的配置文件，重命名为 `config.toml` 即可。本文档只介绍未包含在[命令行参数](/command-line-flags-for-tidb-configuration.md)中的参数。 - -如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 - +> **Tip:** +> +> 如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 ### `split-table` @@ -51,7 +51,7 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ ### `oom-use-tmp-storage` > **警告：** -> +> > 自 v6.3.0 起，该配置项被废弃，其功能由系统变量 [`tidb_enable_tmp_storage_on_oom`](/system-variables.md#tidb_enable_tmp_storage_on_oom) 代替。集群升级到 v6.3.0 及之后的版本后，会自动继承升级前的 `oom-use-tmp-storage` 设置，升级后再设置 `oom-use-tmp-storage` 将不生效。 + 设置是否在单条 SQL 语句的内存使用超出系统变量 [`tidb_mem_quota_query`](/system-variables.md#tidb_mem_quota_query) 限制时为某些算子启用临时磁盘。 diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index fc7edec1e0af..8e5afb3476bb 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -29,9 +29,9 @@ aliases: ['/docs-cn/dev/tiflash/tiflash-configuration/','/docs-cn/dev/reference/ ## TiFlash 配置参数 - -如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 - +> **Tip:** +> +> 如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 ### 配置文件 tiflash.toml @@ -168,7 +168,7 @@ delta_index_cache_size = 0 ## 当查询试图申请超过限制的内存时，查询终止执行并且报错 max_memory_usage = 0 - ## 所有查询过程中，节点对中间数据的内存限制 + ## 所有查询过程中，节点对中间数据的内存限制 ## 设置为整数时，单位为 byte，比如 34359738368 表示 32 GiB 的内存限制，0 表示无限制 ## 设置为 [0.0, 1.0) 之间的浮点数时，指节点总内存的比值，比如 0.8 表示总内存的 80%，0.0 表示无限制 ## 默认值为 0.8，表示总内存的 80% diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index b7eeccedbdf0..170033cb8188 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -12,9 +12,9 @@ TiKV 配置文件比命令行参数支持更多的选项。你可以在 [etc/con 本文档只阐述未包含在命令行参数中的参数，命令行参数参见 [TiKV 配置参数](/command-line-flags-for-tikv-configuration.md)。 - -如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。 - +> **Tip:** +> +> 如果你需要调整配置项的值，请参考[修改配置参数](/maintain-tidb-using-tiup.md#修改配置参数)进行操作。