TiDB Control 使用说明

TiDB Control 是 TiDB 的命令行工具，用于获取 TiDB 状态信息，多用于调试。本文介绍了 TiDB Control 的主要功能和各个功能的使用方法。

获取 TiDB Control

本节提供了两种方式获取 TiDB Control 工具。

tidb-ctl - 图1

注意

建议使用的 Control 工具版本与集群版本保持一致。

通过 TiUP 安装

在安装 TiUP 之后，可以使用 tiup ctl:v<CLUSTER_VERSION> tidb 命令来获取 TiDB Control 的二进制程序以及运行 TiDB Control。

从源代码编译安装

编译环境要求：Go Version 1.19 以上

编译步骤：在 TiDB Control 项目根目录，使用 make 命令进行编译，生成 tidb-ctl。

编译文档：帮助文档在 doc 文件夹下，如丢失或需要更新，可通过 make doc 命令生成帮助文档。

使用介绍

tidb-ctl 的使用由命令（包括子命令）、选项和参数组成。命令即不带 - 或者 -- 的字符，选项即带有 - 或者 -- 的字符，参数即命令或选项字符后紧跟的传递给命令和选项的字符。

如：tidb-ctl schema in mysql -n db

  • schema: 命令
  • in: schema 的子命令
  • mysql: in 的参数
  • -n: 选项
  • db: -n 的参数

目前，TiDB Control 包含以下子命令。

  • tidb-ctl base64decode 用于 BASE64 解码
  • tidb-ctl decoder 用于 KEY 解码
  • tidb-ctl etcd 用于操作 etcd
  • tidb-ctl log 用于格式化日志文件，将单行的堆栈信息展开
  • tidb-ctl mvcc 用于获取 MVCC 信息
  • tidb-ctl region 用于获取 Region 信息
  • tidb-ctl schema 用于获取 Schema 信息
  • tidb-ctl table 用于获取 Table 信息

获取帮助

tidb-ctl -h/--help 用于获取帮助信息。tidb-ctl 由多层命令组成，tidb-ctl 及其所有子命令都可以通过 -h/--help 来获取使用帮助。

以获取 Schema 信息为例：

通过 tidb-ctl schema -h 可以获取这个子命令的使用帮助。schema 有两个子命令——in 和 tid。in 用来通过数据库名获取数据库中所有表的表结构，tid 用来通过全数据库唯一的 table_id 获取表的表结构。

全局参数

tidb-ctl 有 4 个与连接相关的全局参数，分别为：

  • --host TiDB 服务地址
  • --port TiDB status 端口
  • --pdhost PD 服务地址
  • --pdport PD 服务端口
  • --ca 连接使用的 TLS CA 文件路径
  • --ssl-key 连接使用的 TLS 密钥文件路径
  • --ssl-cert 连接使用的 TLS 证书文件路径

其中 --pdhost 和 --pdport 主要是用于 etcd 子命令，例如：tidb-ctl etcd ddlinfo。如不添加地址和端口将使用默认值，TiDB/PD 服务默认的地址是 127.0.0.1（服务地址只能使用 IP 地址），TiDB 服务端口默认的端口是 10080，PD 服务端口默认的端口是 2379 连接选项是全局选项，适用于以下所有命令。

schema 命令

in 子命令

in 子命令用来通过数据库名获取数据库中所有表的表结构。

tidb-ctl schema in {数据库名}

如：tidb-ctl schema in mysql 将得到以下结果

1. [
2. {
3. "id": 13,
4. "name": {
5. "O": "columns_priv",
6. "L": "columns_priv"
7. },
8. ...
9. "update_timestamp": 399494726837600268,
10. "ShardRowIDBits": 0,
11. "Partition": null
12. }
13. ]

结果将以 json 形式展示，内容较长，这里做了截断。

如希望指定表名，可以使用 tidb-ctl schema in {数据库名} -n {表名} 进行过滤。

如：tidb-ctl schema in mysql -n db 将得到 mysql 库中 db 表的表结构。结果如下：

1. {
2. "id": 9,
3. "name": {
4. "O": "db",
5. "L": "db"
6. },
7. ...
8. "Partition": null
9. }

这里同样做了截断。

如使用的 TiDB 地址不为默认地址和端口，可以使用命令行参数 --host, --port 选项，如：tidb-ctl --host 172.16.55.88 --port 8898 schema in mysql -n db。

tid 子命令

tid 子命令用来通过表的 id 获取数据库中表的表结构。

通过使用 in 子命令查询到数据库中表的 id，之后可以通过 tid 子命令查看表的详细信息。

例如，查询到 mysql.stat_meta 表的 id 是 21，可以通过 tidb-ctl schema tid -i 21 查看表的详细信息。

1. {
2. "id": 21,
3. "name": {
4. "O": "stats_meta",
5. "L": "stats_meta"
6. },
7. "charset": "utf8mb4",
8. "collate": "utf8mb4_bin",
9. ...
10. }

同 in 子命令一样，如果使用的 TiDB 地址不是默认的地址和端口，需要通过 --host 和 --port 参数指定 TiDB 的地址和 status 端口。

base64decode 命令

base64decode 用来解码 base64 数据。

基本用法：

1. tidb-ctl base64decode [base64_data]
2. tidb-ctl base64decode [db_name.table_name] [base64_data]
3. tidb-ctl base64decode [table_id] [base64_data]
  1. 准备环境，执行以下 SQL

1. use test; 2. create table t (a int, b varchar(20),c datetime default current_timestamp , d timestamp default current_timestamp, unique index(a)); 3. insert into t (a,b,c) values(1,"哈哈 hello",NULL); 4. alter table t add column e varchar(20); 2. 用 HTTP API 接口获取 MVCC 数据

1. curl "http://$IP:10080/mvcc/index/test/t/a/1?a=1"

1. { 2. "info": { 3. "writes": [ 4. { 5. "start_ts": 407306449994645510, 6. "commit_ts": 407306449994645513, 7. "short_value": "AAAAAAAAAAE=" # unique index a 存的值是对应行的 handle id. 8. } 9. ] 10. } 11. }%

1. curl "http://$IP:10080/mvcc/key/test/t/1"

1. { 2. "info": { 3. "writes": [ 4. { 5. "start_ts": 407306588892692486, 6. "commit_ts": 407306588892692489, 7. "short_value": "CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk=" # handle id 为 1 的行数据。 8. } 9. ] 10. } 11. }% 3. 用 base64decode 解码 handle id (uint64).

1. tidb-ctl base64decode AAAAAAAAAAE=

1. hex: 0000000000000001 2. uint64: 1 4. 用 base64decode 解码行数据。

1. ./tidb-ctl base64decode test.t CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk=

1. a: 1 2. b: 哈哈 hello 3. c is NULL 4. d: 2019-03-28 05:35:30 5. e not found in data

如果 test.t 的 table id 是 60，你也可以使用下列命令获得同样结果：

1. ./tidb-ctl base64decode 60 CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk=

1. a: 1 2. b: 哈哈 hello 3. c is NULL 4. d: 2019-03-28 05:35:30 5. e not found in data

decoder 命令

  • 以下示例解码 row key，index key 类似。

1. ./tidb-ctl decoder "t\x00\x00\x00\x00\x00\x00\x00\x1c_r\x00\x00\x00\x00\x00\x00\x00\xfa"

1. format: table_row 2. table_id: -9223372036854775780 3. row_id: -9223372036854775558 - 以下示例解码 value

1. ./tidb-ctl decoder AhZoZWxsbyB3b3JsZAiAEA==

1. format: index_value 2. index_value[0]: {type: bytes, value: hello world} 3. index_value[1]: {type: bigint, value: 1024}

etcd 命令

  • tidb-ctl etcd ddlinfo 获取 DDL 信息。
  • tidb-ctl etcd putkey KEY VALUE 添加 KEY VALUE 到 etcd（所有的 KEY 会添加到 /tidb/ddl/all_schema_versions/ 之下）。

1. tidb-ctl etcd putkey "foo" "bar"

实际是添加 KEY 为 /tidb/ddl/all_schema_versions/foo，VALUE 为 bar 的键值对到 etcd 中。 - tidb-ctl etcd delkey 删除 etcd 中的 KEY，只有前缀以 /tidb/ddl/fg/owner/ 和 /tidb/ddl/all_schema_versions/ 开头才允许被删除。

1. tidb-ctl etcd delkey "/tidb/ddl/fg/owner/foo" && 2. tidb-ctl etcd delkey "/tidb/ddl/all_schema_versions/bar"

log 命令

TiDB 错误日志的堆栈信息是一行的格式，可以使用 tidb-ctl log 将堆栈信息格式化成多行形式。

keyrange 命令

keyrange 子命令用于查询全局或表相关的关键 key range 信息，以十六进制形式输出。

  • 使用 tidb-ctl keyrange 命令查看全局的关键 key range。

1. tidb-ctl keyrange

1. global ranges: 2. meta: (6d, 6e) 3. table: (74, 75) - 添加 --encode 选项可以显示 encode 过的 key（与 TiKV 及 PD 中的格式相同）。

1. tidb-ctl keyrange --encode

1. global ranges: 2. meta: (6d00000000000000f8, 6e00000000000000f8) 3. table: (7400000000000000f8, 7500000000000000f8) - 使用 tidb-ctl keyrange --database={db} --table={tbl} 命令查看全局和表相关的关键 key range。

1. tidb-ctl keyrange --database test --table ttt

1. global ranges: 2. meta: (6d, 6e) 3. table: (74, 75) 4. table ttt ranges: (NOTE: key range might be changed after DDL) 5. table: (74800000000000002f, 748000000000000030) 6. table indexes: (74800000000000002f5f69, 74800000000000002f5f72) 7. index c2: (74800000000000002f5f698000000000000001, 74800000000000002f5f698000000000000002) 8. index c3: (74800000000000002f5f698000000000000002, 74800000000000002f5f698000000000000003) 9. index c4: (74800000000000002f5f698000000000000003, 74800000000000002f5f698000000000000004) 10. table rows: (74800000000000002f5f72, 748000000000000030)