From 34fde4dcfa30822ef96e94eab79153920443ca38 Mon Sep 17 00:00:00 2001 From: Jack Yu Date: Tue, 16 Jun 2020 13:51:22 +0800 Subject: [PATCH] cherry pick #2832 to release-4.0 Signed-off-by: ti-srebot --- configure-placement-rules.md | 4 ++++ dashboard/dashboard-intro.md | 4 ++++ post-installation-check.md | 4 ++++ sql-statements/sql-statement-create-index.md | 4 ++++ system-tables/system-table-sql-diagnosis.md | 4 ++++ ticdc/ticdc-overview.md | 2 +- tidb-configuration-file.md | 4 ++++ tikv-configuration-file.md | 4 ++++ 8 files changed, 29 insertions(+), 1 deletion(-) diff --git a/configure-placement-rules.md b/configure-placement-rules.md index 06e2b243cba91..9020dd5866917 100644 --- a/configure-placement-rules.md +++ b/configure-placement-rules.md @@ -7,6 +7,10 @@ aliases: ['/docs/stable/how-to/configure/placement-rules/'] # Placement Rules +> **Warning:** +> +> 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. ## Rule system diff --git a/dashboard/dashboard-intro.md b/dashboard/dashboard-intro.md index de237d7a1ac02..0b2eb3ba5a532 100644 --- a/dashboard/dashboard-intro.md +++ b/dashboard/dashboard-intro.md @@ -6,6 +6,10 @@ category: how-to # TiDB Dashboard Introduction +> **Warning:** +> +> 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. ![TiDB Dashboard interface](/media/dashboard/dashboard-intro.gif) 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) diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index bb0cee89f02ac..c83b04c5eacb6 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:** +> +> 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. 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 960dab3f87df9..9ea2eefd3b1cf 100644 --- a/system-tables/system-table-sql-diagnosis.md +++ b/system-tables/system-table-sql-diagnosis.md @@ -7,6 +7,10 @@ aliases: ['/docs/stable/reference/system-databases/sql-diagnosis/'] # SQL Diagnosis +> **Warning:** +> +> 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. The SQL diagnosis system has the following advantages: diff --git a/ticdc/ticdc-overview.md b/ticdc/ticdc-overview.md index c2018094a87cc..b5cecfee04bd3 100644 --- a/ticdc/ticdc-overview.md +++ b/ticdc/ticdc-overview.md @@ -9,7 +9,7 @@ aliases: ['/docs/stable/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. diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index d25a38005fbd0..2c01b4a88145a 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 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"` - 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 106e2c9117343..099a969c69cdf 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:** +> +> 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. ### `min-thread-count`