From d324176cd238c1607c173ac3ee9d9dc271a2a21f Mon Sep 17 00:00:00 2001 From: Shuaipeng Yu Date: Fri, 12 Jun 2020 17:53:39 +0800 Subject: [PATCH 1/8] *: add experimental warning Signed-off-by: Shuaipeng Yu --- configure-placement-rules.md | 4 ++++ production-deployment-using-tiup.md | 4 ++++ sql-statements/sql-statement-create-index.md | 4 ++++ system-tables/system-table-sql-diagnosis.md | 4 ++++ tidb-configuration-file.md | 4 ++++ tikv-configuration-file.md | 4 ++++ 6 files changed, 24 insertions(+) diff --git a/configure-placement-rules.md b/configure-placement-rules.md index b43f81f28b5a2..18d94947e59c6 100644 --- a/configure-placement-rules.md +++ b/configure-placement-rules.md @@ -7,6 +7,10 @@ aliases: ['/docs/dev/how-to/configure/placement-rules/'] # Placement Rules +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + Placement Rules is an experimental feature of the Placement Driver (PD) introduced in v4.0. It is a replica rule system that guides PD to generate corresponding schedules for different types of data. By combining different scheduling rules, you can finely control the attributes of any continuous data range, such as the number of replicas, the storage location, the host type, whether to participate in Raft election, and whether to act as the Raft leader. ## Rule system diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index a22da4f75cfc5..7f13d112c522a 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -7,6 +7,10 @@ aliases: ['/docs/dev/how-to/deploy/orchestrated/tiup/','/docs/dev/tiflash/deploy # Deploy a TiDB Cluster Using TiUP +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + [TiUP](https://github.com/pingcap/tiup) is a cluster operation and maintenance tool introduced in TiDB 4.0. TiUP provides [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster), a cluster management component written in Golang. By using TiUP cluster, you can easily perform daily database operations, including deploying, starting, stopping, destroying, scaling, and upgrading a TiDB cluster, and manage TiDB cluster parameters. TiUP supports deploying TiDB, TiFlash, TiDB Binlog, TiCDC, and the monitoring system. This document introduces how to deploy TiDB clusters of different topologies. diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index f61609ec4569e..7a24cb593f0bb 100644 --- a/sql-statements/sql-statement-create-index.md +++ b/sql-statements/sql-statement-create-index.md @@ -84,6 +84,10 @@ Query OK, 0 rows affected (0.31 sec) ## Expression index +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + TiDB can build indexes not only on one or more columns in a table, but also on an expression. When queries involve expressions, expression indexes can speed up those queries. Take the following query as an example: diff --git a/system-tables/system-table-sql-diagnosis.md b/system-tables/system-table-sql-diagnosis.md index 2e3e4bb605813..9a24684c3e3b1 100644 --- a/system-tables/system-table-sql-diagnosis.md +++ b/system-tables/system-table-sql-diagnosis.md @@ -7,6 +7,10 @@ aliases: ['/docs/dev/reference/system-databases/sql-diagnosis/'] # SQL Diagnosis +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + SQL diagnosis is a feature introduced in TiDB v4.0. You can use this feature to locate problems in TiDB with higher efficiency. Before TiDB v4.0, you need to use different tools to obtain different information. The SQL diagnosis system has the following advantages: diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 33b6cfef44089..d4ac4a19c63f0 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -46,6 +46,10 @@ The TiDB configuration file supports more options than command-line parameters. ### `oom-action` +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + - 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. - Default value: `"cancel"` - The valid options are `"log"` and `"cancel"`. When `oom-action="log"`, it prints the log only. When `oom-action="cancel"`, it cancels the operation and outputs the log. diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 2c39fb7a2a982..897f352ee954a 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -95,6 +95,10 @@ This document only describes the parameters that are not included in command-lin ## readpool.unified +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + Configuration items related to the single thread pool serving read requests. This thread pool supersedes the original storage thread pool and coprocessor thread pool since the 4.0 version. ### `min-thread-count` From b22a940c7de82d06f695e8f12e16474430c59bc1 Mon Sep 17 00:00:00 2001 From: Shuaipeng Yu Date: Mon, 15 Jun 2020 16:17:32 +0800 Subject: [PATCH 2/8] address comments Signed-off-by: Shuaipeng Yu --- dashboard/dashboard-intro.md | 4 ++++ production-deployment-using-tiup.md | 4 ---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dashboard/dashboard-intro.md b/dashboard/dashboard-intro.md index de237d7a1ac02..d20ea6cc7646a 100644 --- a/dashboard/dashboard-intro.md +++ b/dashboard/dashboard-intro.md @@ -6,6 +6,10 @@ category: how-to # TiDB Dashboard Introduction +> **Warning:** +> +> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. + TiDB Dashboard is a Web UI for monitoring, diagnosing, and managing the TiDB cluster, which is available since v4.0. It is built into the PD component and does not require an independent deployment. ![TiDB Dashboard interface](/media/dashboard/dashboard-intro.gif) diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 7f13d112c522a..a22da4f75cfc5 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -7,10 +7,6 @@ aliases: ['/docs/dev/how-to/deploy/orchestrated/tiup/','/docs/dev/tiflash/deploy # Deploy a TiDB Cluster Using TiUP -> **Warning:** -> -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. - [TiUP](https://github.com/pingcap/tiup) is a cluster operation and maintenance tool introduced in TiDB 4.0. TiUP provides [TiUP cluster](https://github.com/pingcap/tiup/tree/master/components/cluster), a cluster management component written in Golang. By using TiUP cluster, you can easily perform daily database operations, including deploying, starting, stopping, destroying, scaling, and upgrading a TiDB cluster, and manage TiDB cluster parameters. TiUP supports deploying TiDB, TiFlash, TiDB Binlog, TiCDC, and the monitoring system. This document introduces how to deploy TiDB clusters of different topologies. From 0b32554600e10cad782384b6122b1bda413772fc Mon Sep 17 00:00:00 2001 From: Shuaipeng Yu Date: Mon, 15 Jun 2020 21:05:59 +0800 Subject: [PATCH 3/8] address comments Signed-off-by: Shuaipeng Yu --- configure-placement-rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configure-placement-rules.md b/configure-placement-rules.md index 18d94947e59c6..32e98c216c268 100644 --- a/configure-placement-rules.md +++ b/configure-placement-rules.md @@ -9,7 +9,7 @@ aliases: ['/docs/dev/how-to/configure/placement-rules/'] > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> In the scenario of using TiFlash, the Placement Rules has been extensively tested and can be used in a production environment. Except for the scenarios where TiFlash is used, using Placement Rules alone has not been extensively tested, so it is not recommended to enable this feature separately in a production environment. Placement Rules is an experimental feature of the Placement Driver (PD) introduced in v4.0. It is a replica rule system that guides PD to generate corresponding schedules for different types of data. By combining different scheduling rules, you can finely control the attributes of any continuous data range, such as the number of replicas, the storage location, the host type, whether to participate in Raft election, and whether to act as the Raft leader. From 89925b6596fd113d4bc7d112af875a03705c2dac Mon Sep 17 00:00:00 2001 From: Jack Yu Date: Mon, 15 Jun 2020 21:08:09 +0800 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- dashboard/dashboard-intro.md | 2 +- sql-statements/sql-statement-create-index.md | 2 +- system-tables/system-table-sql-diagnosis.md | 2 +- tidb-configuration-file.md | 2 +- tikv-configuration-file.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dashboard/dashboard-intro.md b/dashboard/dashboard-intro.md index d20ea6cc7646a..0b2eb3ba5a532 100644 --- a/dashboard/dashboard-intro.md +++ b/dashboard/dashboard-intro.md @@ -8,7 +8,7 @@ category: how-to > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> TiDB Dashboard is still an experimental feature. It is **NOT** recommended that you use it in the production environment. TiDB Dashboard is a Web UI for monitoring, diagnosing, and managing the TiDB cluster, which is available since v4.0. It is built into the PD component and does not require an independent deployment. diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index 7a24cb593f0bb..390cc50580f0a 100644 --- a/sql-statements/sql-statement-create-index.md +++ b/sql-statements/sql-statement-create-index.md @@ -86,7 +86,7 @@ Query OK, 0 rows affected (0.31 sec) > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> Expression index is still an experimental feature. It is **NOT** recommended that you use it in the production environment. TiDB can build indexes not only on one or more columns in a table, but also on an expression. When queries involve expressions, expression indexes can speed up those queries. diff --git a/system-tables/system-table-sql-diagnosis.md b/system-tables/system-table-sql-diagnosis.md index 9a24684c3e3b1..dc1f6066a8b87 100644 --- a/system-tables/system-table-sql-diagnosis.md +++ b/system-tables/system-table-sql-diagnosis.md @@ -9,7 +9,7 @@ aliases: ['/docs/dev/reference/system-databases/sql-diagnosis/'] > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> SQL diagnosis is still an experimental feature. It is **NOT** recommended that you use it in the production environment. SQL diagnosis is a feature introduced in TiDB v4.0. You can use this feature to locate problems in TiDB with higher efficiency. Before TiDB v4.0, you need to use different tools to obtain different information. diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index d4ac4a19c63f0..0fca1440a6a06 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -51,7 +51,7 @@ The TiDB configuration file supports more options than command-line parameters. > This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. - 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. -- Default value: `"cancel"` +- Default value: `"log"` - The valid options are `"log"` and `"cancel"`. When `oom-action="log"`, it prints the log only. When `oom-action="cancel"`, it cancels the operation and outputs the log. ### `enable-streaming` diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 897f352ee954a..5e5f030b8e42c 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -97,7 +97,7 @@ This document only describes the parameters that are not included in command-lin > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> Unified read pool is still an experimental feature. It is **NOT** recommended that you use it in the production environment. Configuration items related to the single thread pool serving read requests. This thread pool supersedes the original storage thread pool and coprocessor thread pool since the 4.0 version. From f38708f6787774a628f3a4be4c9e1c06781eaeee Mon Sep 17 00:00:00 2001 From: Shuaipeng Yu Date: Mon, 15 Jun 2020 21:09:04 +0800 Subject: [PATCH 5/8] update Signed-off-by: Shuaipeng Yu --- tidb-configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index d4ac4a19c63f0..c4a0e189e5bd2 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -48,7 +48,7 @@ The TiDB configuration file supports more options than command-line parameters. > **Warning:** > -> This is still an experimental feature. It is **NOT** recommended that you use this attribute in the production environment. +> This function currently counts the memory during the writing process, which is an experimental feature. For users who want to rely on this feature to cancel the write operation, it is not recommended to configure it as cancel in the production environment. - 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. - Default value: `"cancel"` From 16ce338c64886bef9c94fa2801d0e5d453db0727 Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 16 Jun 2020 13:28:06 +0800 Subject: [PATCH 6/8] Update post-installation-check.md --- post-installation-check.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/post-installation-check.md b/post-installation-check.md index 631d085c33ed2..6651fe0dbe153 100644 --- a/post-installation-check.md +++ b/post-installation-check.md @@ -14,6 +14,10 @@ This section describes how to check the TiDB cluster status using TiDB Dashboard ### Use TiDB Dashboard +> **Note:** +> +> TiDB Dashboard is still an experimental feature. It is **NOT** recommended that you use it in the production environment. + 1. Log in to TiDB Dashboard at `${pd-ip}:${pd-port}/dashboard`. The username and password is the same as that of the TiDB `root` user. If you have modified the `root` password, enter the modified password. The password is empty by default. ![TiDB-Dashboard](/media/tiup/tidb-dashboard.png) From 7ffb443360596398ce9cfe3b43a1d3485c7a0b07 Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 16 Jun 2020 13:29:46 +0800 Subject: [PATCH 7/8] Update ticdc-overview.md --- ticdc/ticdc-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index f2e8b1a48031b..734647bbd65b9 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -9,7 +9,7 @@ aliases: ['/docs/dev/reference/tools/ticdc/overview/'] > **Note:** > -> TiCDC is experimental. It is **not recommended** to use this feature in the production environment. +> TiCDC is still an experimental feature. It is **NOT** recommended that you use it in the production environment. [TiCDC](https://github.com/pingcap/ticdc) is a tool for replicating the incremental data of TiDB. This tool is implemented by pulling TiKV change logs. It can restore data to a consistent state with any upstream TSO, and provides [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md) to support other systems to subscribe to data changes. From c6515e72775e9b6e8b9635ccbe08628d3f2eaf03 Mon Sep 17 00:00:00 2001 From: Jack Yu Date: Tue, 16 Jun 2020 13:31:25 +0800 Subject: [PATCH 8/8] Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- configure-placement-rules.md | 2 +- tidb-configuration-file.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/configure-placement-rules.md b/configure-placement-rules.md index 32e98c216c268..b12eb71d013eb 100644 --- a/configure-placement-rules.md +++ b/configure-placement-rules.md @@ -9,7 +9,7 @@ aliases: ['/docs/dev/how-to/configure/placement-rules/'] > **Warning:** > -> In the scenario of using TiFlash, the Placement Rules has been extensively tested and can be used in a production environment. Except for the scenarios where TiFlash is used, using Placement Rules alone has not been extensively tested, so it is not recommended to enable this feature separately in a production environment. +> In the scenario of using TiFlash, the Placement Rules feature has been extensively tested and can be used in the production environment. Except for the scenario where TiFlash is used, using Placement Rules alone has not been extensively tested, so it is not recommended to enable this feature separately in the production environment. Placement Rules is an experimental feature of the Placement Driver (PD) introduced in v4.0. It is a replica rule system that guides PD to generate corresponding schedules for different types of data. By combining different scheduling rules, you can finely control the attributes of any continuous data range, such as the number of replicas, the storage location, the host type, whether to participate in Raft election, and whether to act as the Raft leader. diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 8f73641748c0c..2b497112cd192 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -48,7 +48,7 @@ The TiDB configuration file supports more options than command-line parameters. > **Warning:** > -> This function currently counts the memory during the writing process, which is an experimental feature. For users who want to rely on this feature to cancel the write operation, it is not recommended to configure it as cancel in the production environment. +> This feature is still an experimental feature, which counts the memory during the writing process. For users who want to use this feature to cancel the write operation, it is not recommended to configure it as `cancel` in the production environment. - 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. - Default value: `"log"`