From 7c7ed6bfe55a846085911af5d1bfb0632a83c21e Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 25 May 2023 10:11:38 +0800 Subject: [PATCH 1/2] This is an automated cherry-pick of #13666 Signed-off-by: ti-chi-bot --- pd-configuration-file.md | 4 ++++ tidb-configuration-file.md | 25 +++++++++++++++++++++++++ tiflash/tiflash-configuration.md | 4 ++++ tikv-configuration-file.md | 4 ++++ 4 files changed, 37 insertions(+) diff --git a/pd-configuration-file.md b/pd-configuration-file.md index e9844d15ea437..957d60c934c7c 100644 --- a/pd-configuration-file.md +++ b/pd-configuration-file.md @@ -12,6 +12,10 @@ The PD configuration file supports more options than command-line parameters. Yo This document only describes parameters that are not included in command-line parameters. Check [here](/command-line-flags-for-pd-configuration.md) for the command line parameters. +> **Tip:** +> +> If you need to adjust the value of a configuration item, refer to [Modify the configuration](/maintain-tidb-using-tiup.md#modify-the-configuration). + ### `name` - The unique name of a PD node diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 7f0e39a5b7bac..4a81312b54e49 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -11,6 +11,10 @@ aliases: ['/docs/stable/reference/configuration/tidb-server/configuration-file/' The TiDB configuration file supports more options than command-line parameters. You can download the default configuration file [`config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) and rename it to `config.toml`. This document describes only the options that are not involved in [command line options](/command-line-flags-for-tidb-configuration.md). +> **Tip:** +> +> If you need to adjust the value of a configuration item, refer to [Modify the configuration](/maintain-tidb-using-tiup.md#modify-the-configuration). + ### `split-table` - Determines whether to create a separate Region for each table. @@ -485,6 +489,27 @@ Configuration items related to performance. + Default value: `1000` + Currently, the valid value range is `[1, 100000]`. +<<<<<<< HEAD +======= +### `lite-init-stats` New in v7.1.0 + +> **Warning:** +> +> This variable is an experimental feature. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. + ++ Controls whether to use lightweight statistics initialization during TiDB startup. ++ Default value: false ++ When the value of `lite-init-stats` is `true`, statistics initialization does not load any histogram, TopN, or Count-Min Sketch of indexes or columns into memory. When the value of `lite-init-stats` is `false`, statistics initialization loads histograms, TopN, and Count-Min Sketch of indexes and primary keys into memory but does not load any histogram, TopN, or Count-Min Sketch of non-primary key columns into memory. When the optimizer needs the histogram, TopN, and Count-Min Sketch of a specific index or column, the necessary statistics are loaded into memory synchronously or asynchronously (controlled by [`tidb_stats_load_sync_wait`](/system-variables.md#tidb_stats_load_sync_wait-new-in-v540)). ++ Setting `lite-init-stats` to `true` speeds up statistics initialization and reduces TiDB memory usage by avoiding unnecessary statistics loading. For details, see [Load statistics](/statistics.md#load-statistics). + +### `force-init-stats` New in v7.1.0 + ++ Controls whether to wait for statistics initialization to finish before providing services during TiDB startup. ++ Default value: false ++ When the value of `force-init-stats` is `true`, TiDB needs to wait until statistics initialization is finished before providing services upon startup. If there are a large number of tables and partitions, setting `force-init-stats` to `true` might prolong the time it takes for TiDB to start providing services. ++ When the value of `force-init-stats` is `false`, TiDB can still provide services before statistics initialization is finished, but the optimizer uses pseudo statistics to make decisions, which might result in suboptimal execution plans. + +>>>>>>> 960264fdc (*: add instruction for editing config (#13666)) ## opentracing Configuration items related to opentracing. diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index ce48a0fbf1d18..00781c4b54ba4 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -34,6 +34,10 @@ You can adjust the PD scheduling parameters using [pd-ctl](/pd-control.md). Note This section introduces the configuration parameters of TiFlash. +> **Tip:** +> +> If you need to adjust the value of a configuration item, refer to [Modify the configuration](/maintain-tidb-using-tiup.md#modify-the-configuration). + ### Configure the `tiflash.toml` file ```toml diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 8b88308a954f2..6e48159de4e46 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -12,6 +12,10 @@ The TiKV configuration file supports more options than command-line parameters. This document only describes the parameters that are not included in command-line parameters. For more details, see [command-line parameter](/command-line-flags-for-tikv-configuration.md). +> **Tip:** +> +> If you need to adjust the value of a configuration item, refer to [Modify the configuration](/maintain-tidb-using-tiup.md#modify-the-configuration). + ## Global configuration ### `abort-on-panic` From 08555ead64f7ee9e607f0173583922c1d4135148 Mon Sep 17 00:00:00 2001 From: Ran Date: Thu, 25 May 2023 10:14:24 +0800 Subject: [PATCH 2/2] Update tidb-configuration-file.md --- tidb-configuration-file.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 4a81312b54e49..7d08b490d4943 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -489,27 +489,6 @@ Configuration items related to performance. + Default value: `1000` + Currently, the valid value range is `[1, 100000]`. -<<<<<<< HEAD -======= -### `lite-init-stats` New in v7.1.0 - -> **Warning:** -> -> This variable is an experimental feature. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. - -+ Controls whether to use lightweight statistics initialization during TiDB startup. -+ Default value: false -+ When the value of `lite-init-stats` is `true`, statistics initialization does not load any histogram, TopN, or Count-Min Sketch of indexes or columns into memory. When the value of `lite-init-stats` is `false`, statistics initialization loads histograms, TopN, and Count-Min Sketch of indexes and primary keys into memory but does not load any histogram, TopN, or Count-Min Sketch of non-primary key columns into memory. When the optimizer needs the histogram, TopN, and Count-Min Sketch of a specific index or column, the necessary statistics are loaded into memory synchronously or asynchronously (controlled by [`tidb_stats_load_sync_wait`](/system-variables.md#tidb_stats_load_sync_wait-new-in-v540)). -+ Setting `lite-init-stats` to `true` speeds up statistics initialization and reduces TiDB memory usage by avoiding unnecessary statistics loading. For details, see [Load statistics](/statistics.md#load-statistics). - -### `force-init-stats` New in v7.1.0 - -+ Controls whether to wait for statistics initialization to finish before providing services during TiDB startup. -+ Default value: false -+ When the value of `force-init-stats` is `true`, TiDB needs to wait until statistics initialization is finished before providing services upon startup. If there are a large number of tables and partitions, setting `force-init-stats` to `true` might prolong the time it takes for TiDB to start providing services. -+ When the value of `force-init-stats` is `false`, TiDB can still provide services before statistics initialization is finished, but the optimizer uses pseudo statistics to make decisions, which might result in suboptimal execution plans. - ->>>>>>> 960264fdc (*: add instruction for editing config (#13666)) ## opentracing Configuration items related to opentracing.