From cac08e8c1a03bb6dd937382f2b2fa8b2030a42fd Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Tue, 19 May 2020 15:52:37 +0800 Subject: [PATCH 01/12] update configure file document --- tidb-configuration-file.md | 41 +++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 36451930a1bd..81e0f514d012 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -16,9 +16,14 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 默认值：true + 如果需要创建大量的表，我们建议把这个参数设置为 false。 +### `token-limit` + ++ 可以同时执行请求的 session 个数 ++ 默认值：1000 + ### `mem-quota-query` -+ 单条 SQL 语句可以占用的最大内存阈值。 ++ 单条 SQL 语句可以占用的最大内存阈值，单位为字节。 + 默认值：1073741824 + 超过该值的请求会被 `oom-action` 定义的行为所处理。 + 该值作为系统变量 [`tidb_mem_quota_query`](/tidb-specific-system-variables.md#tidb_mem_quota_query) 的初始值。 @@ -168,6 +173,12 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 默认值：300ms + 当查询大于这个值，就会当做是一个慢查询，输出到慢查询日志。 +### `record-plan-in-slow-log` + ++ 在慢日志中记录执行计划 ++ 默认值：1 ++ 0 表示关闭，1 表示开启，默认开启 + ### `expensive-threshold` + 输出 `expensive` 操作的行数阈值。 @@ -208,12 +219,6 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 默认值：0 + 默认全部保存；如果设置为 7，会最多保留 7 个老的日志文件。 -#### `log-rotate` - -+ 是否每日创建一个新的日志文件。 -+ 默认值：true -+ 如果设置为 true，每天会新建新的日志文件，如果设置为 false，那么只会输出到一个日志文件。 - ## security 安全相关配置。 @@ -253,11 +258,6 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + ssl 私钥文件路径，用于用 tls 连接 TiKV/PD + 默认值："" -### `skip-grant-table` - -+ 是否跳过权限检查 -+ 默认值：false - ## performance 性能相关配置。 @@ -270,19 +270,19 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ ### `max-memory` -+ Prepare cache LRU 使用的最大内存限制，超过 performance.max-memory * (1 - prepared-plan-cache.memory-guard-ratio) 会剔除 LRU 中的元素。 ++ Prepare plan cache LRU 使用的最大内存限制，超过 performance.max-memory * (1 - prepared-plan-cache.memory-guard-ratio) 会剔除 LRU 中的元素。 + 默认值：0 + 这个配置只有在 prepared-plan-cache.enabled 为 true 的情况才会生效。在 LRU 的 size 大于 prepared-plan-cache.capacity 的情况下，也会剔除 LRU 中的元素。 ### `txn-total-size-limit` -+ TiDB 事务大小限制 ++ TiDB 单个事务大小限制 + 默认值：104857600 (Byte) + 单个事务中，所有 key-value 记录的总大小不能超过该限制。该配置项的最大值不超过 `10737418240`（表示 10GB）。注意，如果使用了以 `Kafka` 为下游消费者的 `binlog`，如：`arbiter` 集群，该配置项的值不能超过 `1073741824`（表示 1GB），因为这是 `Kafka` 的处理单条消息的最大限制，超过该限制 `Kafka` 将会报错。 ### `stmt-count-limit` -+ TiDB 一个事务允许的最大语句条数限制。 ++ TiDB 单个事务允许的最大语句条数限制。 + 默认值：5000 + 在一个事务中，超过 `stmt-count-limit` 条语句后还没有 rollback 或者 commit，TiDB 将会返回 `statement count 5001 exceeds the transaction limitation, autocommit = false` 错误。该限制只在可重试的乐观事务中生效，如果使用悲观事务或者关闭了[事务重试](/optimistic-transaction.md#事务的重试)，事务中的语句数将不受此限制。 @@ -391,11 +391,12 @@ prepare 语句的 Plan cache 设置。 + 默认值：41s + 这个值必须是大于两倍 Raft 选举的超时时间。 -### `max-txn-time-use` +### `max-txn-ttl` -+ 单个事务允许的最大执行时间。 -+ 默认值：590 -+ 单位：秒 ++ 单个事务允许持有相关资源的最大执行时间。 ++ 默认值：600000 ++ 单位：毫秒 ++ 超过此时间的事务只能执行提交或者回滚，提交不一定能够成功 ### `max-batch-size` @@ -528,7 +529,7 @@ TiDB 服务状态相关配置。 ### max-retry-count -+ 悲观事务中每个语句最大重试次数，超出该限制将会报错。 ++ 悲观事务中每个语句最大重试次数，超出该限该语句执行制将会报错。 + 默认值：256 ## experimental From 573fba8f3733be95fb9134827e8da6a6a0947035 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Tue, 19 May 2020 16:09:47 +0800 Subject: [PATCH 02/12] update command line arguments doc --- command-line-flags-for-tidb-configuration.md | 30 ++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index 8c32fcd337ee..a989135f2955 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -37,6 +37,11 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] + 默认："0.0.0.0" + 0.0.0.0 默认会监听所有的网卡地址。如果有多块网卡，可以指定对外提供服务的网卡，如 192.168.100.113 +## `enable-binlog` + ++ 是否产生 tidb binlog ++ 默认: false + ## `-L` + Log 级别 @@ -149,3 +154,28 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] + 输出 TiDB 的版本 + 默认："" + +## `--plugin-dir` + ++ plugin 存放目录 ++ 默认: "/data/deploy/plugin" + +## `--plugin-load` + ++ 需要加载的 plugin 列表，以 "," 逗号分隔 ++ 默认: "" + +## `--affinity-cpus` + ++ 设置 TiDB server cpu 亲和性，以 "," 逗号分隔，例如 "1,2,3" ++ 默认: "" + +## `--repair-list` + ++ 恢复模式下需要修复的表名 ++ 默认: "" + +## `--require-secure-transport` + ++ 是否要求客户端使用 secure 传输模式 ++ 默认: false From 8811f7df8b28eaa3a8ac2c4c195f732922951cd2 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Tue, 19 May 2020 16:21:59 +0800 Subject: [PATCH 03/12] update --- command-line-flags-for-tidb-configuration.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index a989135f2955..5aff3bfa5f21 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -170,9 +170,14 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] + 设置 TiDB server cpu 亲和性，以 "," 逗号分隔，例如 "1,2,3" + 默认: "" +## `--repair-mode` + ++ 是否开启修复模式，仅用于数据修复场景 ++ 默认: false + ## `--repair-list` -+ 恢复模式下需要修复的表名 ++ 修复模式下需要修复的表名 + 默认: "" ## `--require-secure-transport` From 7070bbb46b9fd8a5855d169e858125a718f8446e Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Tue, 19 May 2020 20:07:13 +0800 Subject: [PATCH 04/12] update --- 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 81e0f514d012..75182e57d3f1 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -529,7 +529,7 @@ TiDB 服务状态相关配置。 ### max-retry-count -+ 悲观事务中每个语句最大重试次数，超出该限该语句执行制将会报错。 ++ 悲观事务中单个语句最大重试次数，重试次数超过该限制，语句执行将会报错。 + 默认值：256 ## experimental From 34e453b7846ada941ef6d0e89e09c9a66eb83473 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Tue, 19 May 2020 20:51:35 +0800 Subject: [PATCH 05/12] update --- tidb-configuration-file.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md index 75182e57d3f1..a270046d1cc8 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -270,9 +270,9 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ ### `max-memory` -+ Prepare plan cache LRU 使用的最大内存限制，超过 performance.max-memory * (1 - prepared-plan-cache.memory-guard-ratio) 会剔除 LRU 中的元素。 ++ TiDB 最大使用内存，单位字节 + 默认值：0 -+ 这个配置只有在 prepared-plan-cache.enabled 为 true 的情况才会生效。在 LRU 的 size 大于 prepared-plan-cache.capacity 的情况下，也会剔除 LRU 中的元素。 ++ 默认值 0 表示不受限制 ### `txn-total-size-limit` @@ -393,10 +393,10 @@ prepare 语句的 Plan cache 设置。 ### `max-txn-ttl` -+ 单个事务允许持有相关资源的最大执行时间。 ++ 单个事务持锁的最长时间，超过该时间，该事务的锁可能会被其他事务清除，导致该事务无法成功提交。 + 默认值：600000 + 单位：毫秒 -+ 超过此时间的事务只能执行提交或者回滚，提交不一定能够成功 ++ 超过此时间的事务只能执行提交或者回滚，提交不一定能够成功。 ### `max-batch-size` From a0bb348ca3e2186cec212e84750ebd21b2cb2d4c Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Wed, 20 May 2020 16:01:31 +0800 Subject: [PATCH 06/12] update --- 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 a270046d1cc8..06a77852292c 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -270,7 +270,7 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ ### `max-memory` -+ TiDB 最大使用内存，单位字节 ++ TiDB 最大使用内存，单位为字节 + 默认值：0 + 默认值 0 表示不受限制 From a8b5fcb6234b6f0b2f6eab6699006ef8959920d5 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Wed, 20 May 2020 16:07:11 +0800 Subject: [PATCH 07/12] update --- command-line-flags-for-tidb-configuration.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index 5aff3bfa5f21..81d9a3822311 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -39,8 +39,8 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] ## `enable-binlog` -+ 是否产生 tidb binlog -+ 默认: false ++ 是否产生 TiDB binlog ++ 默认：false ## `-L` @@ -158,29 +158,29 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] ## `--plugin-dir` + plugin 存放目录 -+ 默认: "/data/deploy/plugin" ++ 默认："/data/deploy/plugin" ## `--plugin-load` + 需要加载的 plugin 列表，以 "," 逗号分隔 -+ 默认: "" ++ 默认："" ## `--affinity-cpus` -+ 设置 TiDB server cpu 亲和性，以 "," 逗号分隔，例如 "1,2,3" -+ 默认: "" ++ 设置 TiDB server CPU 亲和性，以 "," 逗号分隔，例如 "1,2,3" ++ 默认："" ## `--repair-mode` + 是否开启修复模式，仅用于数据修复场景 -+ 默认: false ++ 默认：false ## `--repair-list` + 修复模式下需要修复的表名 -+ 默认: "" ++ 默认："" ## `--require-secure-transport` -+ 是否要求客户端使用 secure 传输模式 -+ 默认: false ++ 是否要求客户端使用安全传输模式 ++ 默认：false From d99466eb256e8797a4cf18b28ccff4559b0ec8c2 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Thu, 21 May 2020 11:25:21 +0800 Subject: [PATCH 08/12] update --- command-line-flags-for-tidb-configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/command-line-flags-for-tidb-configuration.md b/command-line-flags-for-tidb-configuration.md index 81d9a3822311..3db8a7727f5a 100644 --- a/command-line-flags-for-tidb-configuration.md +++ b/command-line-flags-for-tidb-configuration.md @@ -37,7 +37,7 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] + 默认："0.0.0.0" + 0.0.0.0 默认会监听所有的网卡地址。如果有多块网卡，可以指定对外提供服务的网卡，如 192.168.100.113 -## `enable-binlog` +## `--enable-binlog` + 是否产生 TiDB binlog + 默认：false @@ -162,7 +162,7 @@ aliases: ['/docs-cn/dev/reference/configuration/tidb-server/configuration/'] ## `--plugin-load` -+ 需要加载的 plugin 列表，以 "," 逗号分隔 ++ 需要加载的 plugin 名称，多个 plugin 以 "," 逗号分隔 + 默认："" ## `--affinity-cpus` From 1427dc917955e5a5df236e4a4251e0f94d3dd39b Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Thu, 21 May 2020 11:28:49 +0800 Subject: [PATCH 09/12] update --- 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 06a77852292c..cf76459bfd3f 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -177,7 +177,7 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 在慢日志中记录执行计划 + 默认值：1 -+ 0 表示关闭，1 表示开启，默认开启 ++ 0 表示关闭，1 表示开启，默认开启，该值作为系统变量 tidb_record_plan_in_slow_log 的初始值。 ### `expensive-threshold` From 7c17646dd2f1bef5bc6dec8edb490e5a7f53db80 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Mon, 25 May 2020 14:51:56 +0800 Subject: [PATCH 10/12] update --- tidb-specific-system-variables.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tidb-specific-system-variables.md b/tidb-specific-system-variables.md index ace30d7b410d..1aeae9c96f34 100644 --- a/tidb-specific-system-variables.md +++ b/tidb-specific-system-variables.md @@ -736,3 +736,11 @@ TiDB 默认会在建表时为新表分裂 Region。开启该变量后，会在 默认值：0 这个变量用来显示上一个 `execute` 语句所使用的执行计划是不是直接从 plan cache 中取出来的。 + +### tidb_record_plan_in_slow_log 从 v4.0 版本开始引入 + +作用域：SESSION + +默认值：1 + +这个变量用来配置是否在慢查询日志中记录语句执行计划，默认开启。 From 161bc557a72cdef265a31c60f2e5611e39bfddd3 Mon Sep 17 00:00:00 2001 From: cfzjywxk Date: Mon, 25 May 2020 15:01:28 +0800 Subject: [PATCH 11/12] update --- 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 cf76459bfd3f..267664842188 100644 --- a/tidb-configuration-file.md +++ b/tidb-configuration-file.md @@ -177,7 +177,7 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/ + 在慢日志中记录执行计划 + 默认值：1 -+ 0 表示关闭，1 表示开启，默认开启，该值作为系统变量 tidb_record_plan_in_slow_log 的初始值。 ++ 0 表示关闭，1 表示开启，默认开启，该值作为系统变量 [`tidb_record_plan_in_slow_log`](/tidb-specific-system-variables.md#tidb_record_plan_in_slow_log) 的初始值。 ### `expensive-threshold` From b0cfa1cb60772774046e37120dba8a09a0906929 Mon Sep 17 00:00:00 2001 From: yikeke Date: Mon, 25 May 2020 15:31:15 +0800 Subject: [PATCH 12/12] fix a typo in tiup doc --- tiup/tiup-troubleshooting-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-troubleshooting-guide.md b/tiup/tiup-troubleshooting-guide.md index e1213ef46f70..3be9905397e3 100644 --- a/tiup/tiup-troubleshooting-guide.md +++ b/tiup/tiup-troubleshooting-guide.md @@ -38,7 +38,7 @@ TiUP 并不会每次都从镜像服务器更新最新的组件列表，可以通 2. 如果指定了 `-i` 参数，可能是由于指定的私钥不能登录，可以通过手动执行 `ssh -i identity_file user@remote` 命令来验证。 3. 如果是通过密码登录远程主机，请确保指定了 `-p` 参数，同时输入了正确的登录密码。 -### 2.3 使用 TiUP Cluster 升级中断 +### 2.2 使用 TiUP Cluster 升级中断 为了避免用户误用，TiUP Cluster 不支持指定部分节点升级，所以升级失败之后，需要重新进行升级操作，包括升级过程中的幂等操作。