Skip to content

Latest commit

 

History

History
225 lines (183 loc) · 15.5 KB

sql-statement-admin-show-ddl.md

File metadata and controls

225 lines (183 loc) · 15.5 KB
Raw
title summary
ADMIN SHOW DDL [JOBS|JOB QUERIES]
TiDB 数据库中 ADMIN SHOW DDL [JOBS|JOB QUERIES] 的使用概况。

ADMIN SHOW DDL [JOBS|JOB QUERIES]

ADMIN SHOW DDL [JOBS|JOB QUERIES] 语句显示了正在运行和最近完成的 DDL 作业的信息。

语法图

AdminShowDDLStmt ::=
    'ADMIN' 'SHOW' 'DDL'
    (
        'JOBS' Int64Num? WhereClauseOptional
    |   'JOB' 'QUERIES' NumList
    |   'JOB' 'QUERIES' 'LIMIT' m ( ('OFFSET' | ',') n )?
    )?

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

WhereClauseOptional ::=
    WhereClause?

示例

ADMIN SHOW DDL

可以通过 ADMIN SHOW DDL 语句查看当前正在运行的 DDL 作业状态，包括当前 schema 版本号、Owner 的 DDL ID 和地址、正在执行的 DDL 任务和 SQL、当前 TiDB 实例的 DDL ID。该语句返回的结果字段描述如下：

  • SCHEMA_VER：schema 版本号。
  • OWNER_ID：DDL Owner 的 UUID。参见 TIDB_IS_DDL_OWNER()。
  • OWNER_ADDRESS：DDL Owner 的 IP 地址。
  • RUNNING_JOBS：正在运行的 DDL 作业的详细信息。
  • SELF_ID：当前连接的 TiDB 节点的 UUID。如果 SELF_ID 与 OWNER_ID 相同，这意味着你当前连接的是 DDL Owner。
  • QUERY：查询语句。
ADMIN SHOW DDL\G;
*************************** 1. row ***************************
   SCHEMA_VER: 26
     OWNER_ID: 2d1982af-fa63-43ad-a3d5-73710683cc63
OWNER_ADDRESS: 0.0.0.0:4000
 RUNNING_JOBS:
      SELF_ID: 2d1982af-fa63-43ad-a3d5-73710683cc63
        QUERY:
1 row in set (0.00 sec)

ADMIN SHOW DDL JOBS

ADMIN SHOW DDL JOBS 语句用于查看当前 DDL 作业队列中的 10 个任务，包括正在运行和等待执行的任务（如果有的话），以及已执行完成的 DDL 作业队列中的最近 10 个任务（如果有的话）。该语句的返回结果字段描述如下：

  • JOB_ID：每个 DDL 操作对应一个 DDL 任务，JOB_ID 全局唯一。
  • DB_NAME：执行 DDL 操作的数据库的名称。
  • TABLE_NAME：执行 DDL 操作的表的名称。
  • JOB_TYPE：DDL 任务的类型。常见的任务类型包括：
  • SCHEMA_STATE：DDL 所操作的 schema 对象的当前状态。如果 JOB_TYPE 是 ADD INDEX，则为索引的状态；如果是 ADD COLUMN，则为列的状态；如果是 CREATE TABLE，则为表的状态。常见的状态有以下几种：
    • none：表示不存在。一般 DROP 操作或者 CREATE 操作失败回滚后，会变为 none 状态。
    • delete only、write only、delete reorganization、write reorganization：这四种状态是中间状态，具体含义请参考 TiDB 中在线 DDL 异步变更的原理。由于中间状态转换很快，一般操作中看不到这几种状态，只有执行 ADD INDEX 操作时能看到处于 write reorganization 状态，表示正在添加索引数据。
    • public：表示存在且对用户可用。一般 CREATE TABLE 和 ADD INDEX（或 ADD COLUMN）等操作完成后，会变为 public 状态，表示新建的表、列、索引可以正常读写了。
  • SCHEMA_ID：执行 DDL 操作的数据库的 ID。
  • TABLE_ID：执行 DDL 操作的表的 ID。
  • ROW_COUNT：执行 ADD INDEX 操作时，当前已经添加完成的数据行数。
  • CREATE_TIME：DDL 操作的创建时间。
  • START_TIME：DDL 操作的开始时间。
  • END_TIME：DDL 操作的结束时间。
  • STATE：DDL 操作的状态。常见的状态有以下几种：
    • none：表示该操作尚未开始。
    • queueing：表示该操作任务已经进入 DDL 任务队列中，但尚未执行，因为还在排队等待前面的 DDL 任务完成。另一种原因可能是执行 DROP 操作后，queueing 状态会变为 done 状态，但是很快会更新为 synced 状态，表示所有 TiDB 实例都已经同步到该状态。
    • running：表示该操作正在执行。
    • synced：表示该操作已经执行成功，且所有 TiDB 实例都已经同步该状态。
    • rollback done：表示该操作执行失败，回滚完成。
    • rollingback：表示该操作执行失败，正在回滚。
    • cancelling：表示正在取消该操作。这个状态只有在用 ADMIN CANCEL DDL JOBS 命令取消 DDL 任务时才会出现。
    • cancelled：表示该操作已经取消。
    • pausing：表示正在暂停该操作。
    • paused：表示 DDL 已被暂停运行。这个状态只有在用 ADMIN PAUSED DDL JOBS 命令暂停 DDL 任务时才会出现。可以通过 ADMIN RESUME DDL JOBS 命令进行恢复运行。
    • done：表示该操作在 TiDB owner 节点已经执行成功，但其他 TiDB 节点还没有同步该 DDL 任务所执行的变更。
  • COMMENTS：包含其他辅助诊断用的信息。
    • ingest：通过 tidb_ddl_enable_fast_reorg 配置的加速索引回填的 ingest 任务。
    • txn：关闭 tidb_ddl_enable_fast_reorg 后，基于事务方式的索引回填。
    • txn-merge：在回填完成时，将临时索引与原始索引合并的事务性回填。
    • DXF：通过 tidb_enable_dist_task 配置的用分布式执行框架 (Distributed eXecution Framework, DXF) 执行的任务。
    • service_scope：通过 tidb_service_scope 配置的 TiDB 节点的服务范围。
    • thread：回填任务的并发度，可通过 tidb_ddl_reorg_worker_cnt 设置初始值。支持 ADMIN ALTER DDL JOBS 动态修改。
    • batch_size：回填任务的批大小，可通过 tidb_ddl_reorg_batch_size 设置初始值。支持 ADMIN ALTER DDL JOBS 动态修改。
    • max_write_speed：ingest 任务导入过程中的流量控制，可通过 tidb_ddl_reorg_max_write_speed 设置初始值。支持使用 ADMIN ALTER DDL JOBS 动态修改。

示例如下：

ADMIN SHOW DDL JOBS;
+--------+---------+------------+---------------------------------+----------------------+-----------+----------+-----------+----------------------------+----------------------------+----------------------------+----------+-------------+
| JOB_ID | DB_NAME | TABLE_NAME | JOB_TYPE                        | SCHEMA_STATE         | SCHEMA_ID | TABLE_ID | ROW_COUNT | CREATE_TIME                | START_TIME                 | END_TIME                   | STATE    | COMMENTS    |
+--------+---------+------------+---------------------------------+----------------------+-----------+----------+-----------+----------------------------+----------------------------+----------------------------+----------+-------------+
|    565 | test    | sbtest1    | add index                       | write reorganization |       554 |      556 |         0 | 2024-11-22 12:39:25.475000 | 2024-11-22 12:39:25.524000 | NULL                       | running  | ingest, DXF |
|    566 | test    | sbtest1    | add index                       | none                 |       554 |      556 |         0 | 2024-11-22 12:39:26.425000 | NULL                       | NULL                       | queueing |             |
|    564 | test    | sbtest1    | alter table multi-schema change | none                 |       554 |      556 |         0 | 2024-11-22 12:39:02.925000 | 2024-11-22 12:39:02.925000 | 2024-11-22 12:39:03.275000 | synced   |             |
|    564 | test    | sbtest1    | drop index /* subjob */         | none                 |       554 |      556 |         0 | 2024-11-22 12:39:02.925000 | 2024-11-22 12:39:02.925000 | 2024-11-22 12:39:03.275000 | done     |             |
|    564 | test    | sbtest1    | drop index /* subjob */         | none                 |       554 |      556 |         0 | 2024-11-22 12:39:02.925000 | 2024-11-22 12:39:02.975000 | 2024-11-22 12:39:03.275000 | done     |             |
|    563 | test    | sbtest1    | modify column                   | public               |       554 |      556 |         0 | 2024-11-22 12:38:35.624000 | 2024-11-22 12:38:35.624000 | 2024-11-22 12:38:35.674000 | synced   |             |
|    562 | test    | sbtest1    | add index                       | public               |       554 |      556 |   1580334 | 2024-11-22 12:36:58.471000 | 2024-11-22 12:37:05.271000 | 2024-11-22 12:37:13.374000 | synced   | ingest, DXF |
|    561 | test    | sbtest1    | add index                       | public               |       554 |      556 |   1580334 | 2024-11-22 12:36:57.771000 | 2024-11-22 12:36:57.771000 | 2024-11-22 12:37:04.671000 | synced   | ingest, DXF |
|    560 | test    | sbtest1    | add index                       | public               |       554 |      556 |   1580334 | 2024-11-22 12:34:53.314000 | 2024-11-22 12:34:53.314000 | 2024-11-22 12:34:57.114000 | synced   | ingest      |
|    559 | test    | sbtest1    | drop index                      | none                 |       554 |      556 |         0 | 2024-11-22 12:34:43.565000 | 2024-11-22 12:34:43.565000 | 2024-11-22 12:34:43.764000 | synced   |             |
|    558 | test    | sbtest1    | add index                       | public               |       554 |      556 |   1580334 | 2024-11-22 12:34:06.215000 | 2024-11-22 12:34:06.215000 | 2024-11-22 12:34:14.314000 | synced   | ingest, DXF |
|    557 | test    | sbtest1    | create table                    | public               |       554 |      556 |         0 | 2024-11-22 12:32:09.515000 | 2024-11-22 12:32:09.915000 | 2024-11-22 12:32:10.015000 | synced   |             |
|    555 | test    |            | create schema                   | public               |       554 |        0 |         0 | 2024-11-22 12:31:51.215000 | 2024-11-22 12:31:51.264000 | 2024-11-22 12:31:51.264000 | synced   |             |
|    553 | test    |            | drop schema                     | none                 |         2 |        0 |         0 | 2024-11-22 12:31:48.615000 | 2024-11-22 12:31:48.615000 | 2024-11-22 12:31:48.865000 | synced   |             |
+--------+---------+------------+---------------------------------+----------------------+-----------+----------+-----------+----------------------------+----------------------------+----------------------------+----------+-------------+
14 rows in set (0.00 sec)

由上述 ADMIN 查询结果可知：

  • job_id 为 565 的 DDL 作业当前正在进行中（STATE 列显示为 running）。SCHEMA_STATE 列显示了表当前处于 write reorganization 状态，一旦任务完成，将更改为 public，以便用户会话可以公开观察到状态变更。end_time 列显示为 NULL，表明当前作业的完成时间未知。

  • job_id 为 566 的 STATE 显示为 queueing，表明它正在排队等待。当作业 565 完成后，作业 566 开始执行时，作业 566 的 STATE 将更改为 running。

  • 对于破坏性的更改（例如删除索引或删除表），当作业完成时，SCHEMA_STATE 将变为 none。对于附加更改，SCHEMA_STATE 将变为 public。

若要限制表中显示的行数，可以指定 NUM 和 WHERE 条件：

ADMIN SHOW DDL JOBS [NUM] [WHERE where_condition];
  • NUM：用于查看已经执行完成的 DDL 作业队列中最近 NUM 条结果；未指定时，默认值为 10。
  • WHERE：WHERE 子句，用于添加过滤条件。

ADMIN SHOW DDL JOB QUERIES

ADMIN SHOW DDL JOB QUERIES 语句用于查看 job_id 对应的 DDL 任务的原始 SQL 语句：

ADMIN SHOW DDL JOBS;
ADMIN SHOW DDL JOB QUERIES 51;
ADMIN SHOW DDL JOB QUERIES 51;
+--------------------------------------------------------------+
| QUERY                                                        |
+--------------------------------------------------------------+
| CREATE TABLE t1 (id INT NOT NULL PRIMARY KEY auto_increment) |
+--------------------------------------------------------------+
1 row in set (0.02 sec)

只能在 DDL 历史作业队列中最近十条结果中搜索与 job_id 对应的正在运行中的 DDL 作业。

ADMIN SHOW DDL JOB QUERIES LIMIT m OFFSET n

ADMIN SHOW DDL JOB QUERIES LIMIT m OFFSET n 语句用于查看指定范围 [n+1, n+m] 的 job_id 对应的 DDL 任务的原始 SQL 语句：

ADMIN SHOW DDL JOB QUERIES LIMIT m;           # -- 取出前 m 行
ADMIN SHOW DDL JOB QUERIES LIMIT n, m;        # -- 取出第 n+1 到 n+m 行
ADMIN SHOW DDL JOB QUERIES LIMIT m OFFSET n;  # -- 取出第 n+1 到 n+m 行

以上语法中 n 和 m 都是非负整数。语法的具体示例如下：

ADMIN SHOW DDL JOB QUERIES LIMIT 3;  # Retrieve first 3 rows
+--------+--------------------------------------------------------------+
| JOB_ID | QUERY                                                        |
+--------+--------------------------------------------------------------+
|     59 | ALTER TABLE t1 ADD INDEX index2 (col2)                       |
|     60 | ALTER TABLE t2 ADD INDEX index1 (col1)                       |
|     58 | CREATE TABLE t2 (id INT NOT NULL PRIMARY KEY auto_increment) |
+--------+--------------------------------------------------------------+
3 rows in set (0.00 sec)
ADMIN SHOW DDL JOB QUERIES LIMIT 6, 2;  # Retrieve rows 7-8
+--------+----------------------------------------------------------------------------+
| JOB_ID | QUERY                                                                      |
+--------+----------------------------------------------------------------------------+
|     52 | ALTER TABLE t1 ADD INDEX index1 (col1)                                     |
|     51 | CREATE TABLE IF NOT EXISTS t1 (id INT NOT NULL PRIMARY KEY auto_increment) |
+--------+----------------------------------------------------------------------------+
3 rows in set (0.00 sec)
ADMIN SHOW DDL JOB QUERIES LIMIT 3 OFFSET 4;  # Retrieve rows 5-7
+--------+----------------------------------------+
| JOB_ID | QUERY                                  |
+--------+----------------------------------------+
|     54 | DROP TABLE IF EXISTS t3                |
|     53 | ALTER TABLE t1 DROP INDEX index1       |
|     52 | ALTER TABLE t1 ADD INDEX index1 (col1) |
+--------+----------------------------------------+
3 rows in set (0.00 sec)

该语句可以在 DDL 历史作业队列任意指定范围中搜索与 job_id 对应的正在运行中的 DDL 作业，没有 ADMIN SHOW DDL JOB QUERIES 语句的最近 10 条结果的限制。

MySQL 兼容性

ADMIN SHOW DDL [JOBS|JOB QUERIES] 语句是 TiDB 对 MySQL 语法的扩展。

另请参阅