ADMIN

该语句是 TiDB 的扩展语法，用于查看 TiDB 的状态以及检查 TiDB 中表的数据。本文档介绍以下与 ADMIN 相关的语句：

ADMIN RELOAD
ADMIN PLUGINS
ADMIN ... BINDINGS
ADMIN REPAIR
ADMIN SHOW NEXT_ROW_ID
ADMIN SHOW SLOW

DDL 相关语句

语句	描述
`ADMIN CANCEL DDL JOBS`	取消当前正在运行的 DDL 任务。
`ADMIN PAUSE DDL JOBS`	暂停当前正在运行的 DDL 任务。
`ADMIN RESUME DDL JOBS`	恢复已暂停的 DDL 任务。
`ADMIN CHECKSUM TABLE`	计算表的所有行和索引的 CRC64。
`ADMIN CHECK [TABLE\|INDEX]`	检查表或索引的一致性。
`ADMIN SHOW DDL [JOBS\|QUERIES]`	显示当前正在运行或最近完成的 DDL 任务的详细信息。

`ADMIN RELOAD` 语句

ADMIN RELOAD expr_pushdown_blacklist;

上述语句用于重新加载表达式下推黑名单。

ADMIN RELOAD opt_rule_blacklist;

上述语句用于重新加载逻辑优化规则黑名单。

`ADMIN PLUGINS` 相关语句

注意

该功能在 TiDB Cloud Serverless 和 TiDB Cloud Essential 集群中不可用。

ADMIN PLUGINS ENABLE plugin_name [, plugin_name] ...;

上述语句用于启用 plugin_name 插件。

ADMIN PLUGINS DISABLE plugin_name [, plugin_name] ...;

上述语句用于禁用 plugin_name 插件。

`ADMIN BINDINGS` 相关语句

ADMIN FLUSH BINDINGS;

上述语句用于持久化 SQL 执行计划绑定信息。

ADMIN CAPTURE BINDINGS;

上述语句可以从出现多次的 SELECT 语句中生成 SQL 执行计划绑定。

ADMIN EVOLVE BINDINGS;

开启自动绑定功能后，每隔 bind-info-leave（默认值为 3s）会触发一次 SQL 执行计划绑定信息的进化。上述语句用于主动触发该进化过程。

ADMIN RELOAD BINDINGS;

上述语句用于重新加载 SQL 执行计划绑定信息。

`ADMIN REPAIR` 语句

注意

该 TiDB 语句不适用于 TiDB Cloud。

在极端情况下需要以不可信的方式覆盖存储表的元数据时，可以使用 ADMIN REPAIR TABLE：

ADMIN REPAIR TABLE tbl_name CREATE TABLE STATEMENT;

`ADMIN SHOW NEXT_ROW_ID` 语句

ADMIN SHOW t NEXT_ROW_ID;

上述语句用于查看表中某些特殊列的详细信息。输出内容与 SHOW TABLE NEXT_ROW_ID 相同。

`ADMIN SHOW SLOW` 语句

注意

该功能在 TiDB Cloud Serverless 和 TiDB Cloud Essential 集群中不可用。

ADMIN SHOW SLOW RECENT N;

ADMIN SHOW SLOW TOP [INTERNAL | ALL] N;

语法

AdminStmt
NumList
AdminStmtLimitOpt
TableNameList

AdminStmt ::=
    'ADMIN' ( 
        'SHOW' ( 
            'DDL' ( 
                'JOBS' Int64Num? WhereClauseOptional 
                | 'JOB' 'QUERIES' (NumList | AdminStmtLimitOpt)
            )? 
            | TableName 'NEXT_ROW_ID' 
            | 'SLOW' AdminShowSlow 
            | 'BDR' 'ROLE'
        ) 
        | 'CHECK' ( 
            'TABLE' TableNameList 
            | 'INDEX' TableName Identifier ( HandleRange ( ',' HandleRange )* )? 
        ) 
        | 'RECOVER' 'INDEX' TableName Identifier 
        | 'CLEANUP' ( 
            'INDEX' TableName Identifier 
            | 'TABLE' 'LOCK' TableNameList ) 
        | 'CHECKSUM' 'TABLE' TableNameList | 'CANCEL' 'DDL' 'JOBS' NumList 
        | ( 'CANCEL' | 'PAUSE' | 'RESUME' ) 'DDL' 'JOBS' NumList
        | 'RELOAD' (
            'EXPR_PUSHDOWN_BLACKLIST' 
            | 'OPT_RULE_BLACKLIST' 
            | 'BINDINGS'
            | 'STATS_EXTENDED'
            | 'STATISTICS'
        ) 
        | 'PLUGINS' ( 'ENABLE' | 'DISABLE' ) PluginNameList 
        | 'REPAIR' 'TABLE' TableName CreateTableStmt 
        | ( 'FLUSH' | 'CAPTURE' | 'EVOLVE' ) 'BINDINGS'
        | 'FLUSH' ('SESSION' | 'INSTANCE') 'PLAN_CACHE'
        | 'SET' 'BDR' 'ROLE' ( 'PRIMARY' | 'SECONDARY' )
        | 'UNSET' 'BDR' 'ROLE'
    )

NumList ::=
    Int64Num ( ',' Int64Num )*

AdminStmtLimitOpt ::=
    'LIMIT' LengthNum
|    'LIMIT' LengthNum ',' LengthNum
|    'LIMIT' LengthNum 'OFFSET' LengthNum

TableNameList ::=
    TableName ( ',' TableName )*

示例

执行以下命令可查看当前 DDL 任务队列中最近完成的 10 个 DDL 任务。当未指定 NUM 时，默认只展示最近完成的 10 个 DDL 任务。

ADMIN SHOW DDL JOBS;

+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| JOB_ID | DB_NAME | TABLE_NAME | JOB_TYPE            | SCHEMA_STATE   | SCHEMA_ID | TABLE_ID | ROW_COUNT | START_TIME                        | END_TIME                          | STATE         |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| 45     | test    | t1         | add index     | write reorganization | 32        | 37       | 0         | 2019-01-10 12:38:36.501 +0800 CST |                                   | running       |
| 44     | test    | t1         | add index     | none                 | 32        | 37       | 0         | 2019-01-10 12:36:55.18 +0800 CST  | 2019-01-10 12:36:55.852 +0800 CST | rollback done |
| 43     | test    | t1         | add index     | public               | 32        | 37       | 6         | 2019-01-10 12:35:13.66 +0800 CST  | 2019-01-10 12:35:14.925 +0800 CST | synced        |
| 42     | test    | t1         | drop index    | none                 | 32        | 37       | 0         | 2019-01-10 12:34:35.204 +0800 CST | 2019-01-10 12:34:36.958 +0800 CST | synced        |
| 41     | test    | t1         | add index     | public               | 32        | 37       | 0         | 2019-01-10 12:33:22.62 +0800 CST  | 2019-01-10 12:33:24.625 +0800 CST | synced        |
| 40     | test    | t1         | drop column   | none                 | 32        | 37       | 0         | 2019-01-10 12:33:08.212 +0800 CST | 2019-01-10 12:33:09.78 +0800 CST  | synced        |
| 39     | test    | t1         | add column    | public               | 32        | 37       | 0         | 2019-01-10 12:32:55.42 +0800 CST  | 2019-01-10 12:32:56.24 +0800 CST  | synced        |
| 38     | test    | t1         | create table  | public               | 32        | 37       | 0         | 2019-01-10 12:32:41.956 +0800 CST | 2019-01-10 12:32:43.956 +0800 CST | synced        |
| 36     | test    |            | drop table    | none                 | 32        | 34       | 0         | 2019-01-10 11:29:59.982 +0800 CST | 2019-01-10 11:30:00.45 +0800  CST | synced        |
| 35     | test    |            | create table  | public               | 32        | 34       | 0         | 2019-01-10 11:29:40.741 +0800 CST | 2019-01-10 11:29:41.682 +0800 CST | synced        |
| 33     | test    |            | create schema | public               | 32        | 0        | 0         | 2019-01-10 11:29:22.813 +0800 CST | 2019-01-10 11:29:23.954 +0800 CST | synced        |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+

执行以下命令可查看当前 DDL 任务队列中最近完成的 5 个 DDL 任务：

ADMIN SHOW DDL JOBS 5;

+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| JOB_ID | DB_NAME | TABLE_NAME | JOB_TYPE            | SCHEMA_STATE   | SCHEMA_ID | TABLE_ID | ROW_COUNT | START_TIME                        | END_TIME                          | STATE         |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| 45     | test    | t1         | add index     | write reorganization | 32        | 37       | 0         | 2019-01-10 12:38:36.501 +0800 CST |                                   | running       |
| 44     | test    | t1         | add index     | none                 | 32        | 37       | 0         | 2019-01-10 12:36:55.18 +0800 CST  | 2019-01-10 12:36:55.852 +0800 CST | rollback done |
| 43     | test    | t1         | add index     | public               | 32        | 37       | 6         | 2019-01-10 12:35:13.66 +0800 CST  | 2019-01-10 12:35:14.925 +0800 CST | synced        |
| 42     | test    | t1         | drop index    | none                 | 32        | 37       | 0         | 2019-01-10 12:34:35.204 +0800 CST | 2019-01-10 12:34:36.958 +0800 CST | synced        |
| 41     | test    | t1         | add index     | public               | 32        | 37       | 0         | 2019-01-10 12:33:22.62 +0800 CST  | 2019-01-10 12:33:24.625 +0800 CST | synced        |
| 40     | test    | t1         | drop column   | none                 | 32        | 37       | 0         | 2019-01-10 12:33:08.212 +0800 CST | 2019-01-10 12:33:09.78 +0800 CST  | synced        |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+

执行以下命令可查看表中某些特殊列的详细信息。输出内容与 SHOW TABLE NEXT_ROW_ID 相同。

ADMIN SHOW t NEXT_ROW_ID;

+---------+------------+-------------+--------------------+----------------+
| DB_NAME | TABLE_NAME | COLUMN_NAME | NEXT_GLOBAL_ROW_ID | ID_TYPE        |
+---------+------------+-------------+--------------------+----------------+
| test    | t          | _tidb_rowid |                101 | _TIDB_ROWID    |
| test    | t          | _tidb_rowid |                  1 | AUTO_INCREMENT |
+---------+------------+-------------+--------------------+----------------+
2 rows in set (0.01 sec)

执行以下命令可查看 test 数据库中未完成的 DDL 任务。结果包括正在运行的 DDL 任务以及最近完成但失败的 5 个 DDL 任务。

ADMIN SHOW DDL JOBS 5 WHERE state != 'synced' AND db_name = 'test';

+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| JOB_ID | DB_NAME | TABLE_NAME | JOB_TYPE            | SCHEMA_STATE   | SCHEMA_ID | TABLE_ID | ROW_COUNT | START_TIME                        | END_TIME                          | STATE         |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+
| 45     | test    | t1         | add index     | write reorganization | 32        | 37       | 0         | 2019-01-10 12:38:36.501 +0800 CST |                                   | running       |
| 44     | test    | t1         | add index     | none                 | 32        | 37       | 0         | 2019-01-10 12:36:55.18 +0800 CST  | 2019-01-10 12:36:55.852 +0800 CST | rollback done |
+--------+---------+------------+---------------------+----------------+-----------+----------+-----------+-----------------------------------+-----------------------------------+---------------+

JOB_ID：每个 DDL 操作对应一个 DDL 任务。JOB_ID 在全局范围内唯一。
DB_NAME：执行 DDL 操作的数据库名称。
TABLE_NAME：执行 DDL 操作的表名称。
JOB_TYPE：DDL 操作的类型。
SCHEMA_STATE：当前的 schema 状态。如果 JOB_TYPE 为 add index，则为索引的状态；如果为 add column，则为列的状态；如果为 create table，则为表的状态。常见状态包括：
- none：表示不存在。当 drop 或 create 操作失败并回滚时，通常会变为 none 状态。
- delete only、write only、delete reorganization、write reorganization：这四种状态为中间态。由于中间态转换非常快，常规操作中一般不可见。只有在 add index 操作中可能看到 write reorganization，表示正在添加索引数据。
- public：表示存在且可用。当 create table、add index/column 等操作完成后，通常会变为 public 状态，表示新建的表/列/索引可以正常读写。
SCHEMA_ID：执行 DDL 操作的数据库 ID。
TABLE_ID：执行 DDL 操作的表 ID。
ROW_COUNT：执行 add index 操作时已添加的数据行数。
START_TIME：DDL 操作的开始时间。
END_TIME：DDL 操作的结束时间。
STATE：DDL 操作的状态。常见状态包括：
- none：表示操作任务已进入 DDL 任务队列但尚未执行，正在等待前序任务完成。也可能在执行 drop 操作后变为 none，但很快会更新为 synced，表示所有 TiDB 实例已同步到该状态。
- running：表示操作正在执行中。
- synced：表示操作已成功执行，且所有 TiDB 实例已同步到该状态。
- rollback done：表示操作失败且已完成回滚。
- rollingback：表示操作失败，正在回滚中。
- cancelling：表示操作正在被取消。该状态仅在你使用 ADMIN CANCEL DDL JOBS 命令取消 DDL 任务时出现。
- paused：表示操作已被暂停。该状态仅在你使用 ADMIN PAUSED DDL JOBS 命令暂停 DDL 任务时出现。你可以使用 ADMIN RESUME DDL JOBS 命令恢复 DDL 任务。

MySQL 兼容性

该语句是 TiDB 对 MySQL 语法的扩展。

ADMIN

DDL 相关语句

ADMIN RELOAD 语句

ADMIN PLUGINS 相关语句

ADMIN BINDINGS 相关语句

ADMIN REPAIR 语句

ADMIN SHOW NEXT_ROW_ID 语句

ADMIN SHOW SLOW 语句

语法

示例