ADMIN SHOW DDL [JOBS|JOB QUERIES]

    AdminStmt

    NumList

    ADMIN SHOW DDL [JOBS|QUERIES] - 图2

    WhereClauseOptional

    1. ADMIN SHOW DDL;
    1. ADMIN SHOW DDL;
    2. +------------+--------------------------------------+---------------+--------------+--------------------------------------+-------+
    3. | SCHEMA_VER | OWNER_ID                             | OWNER_ADDRESS | RUNNING_JOBS | SELF_ID                              | QUERY |
    4. +------------+--------------------------------------+---------------+--------------+--------------------------------------+-------+
    5. |         26 | 2d1982af-fa63-43ad-a3d5-73710683cc63 | 0.0.0.0:4000  |              | 2d1982af-fa63-43ad-a3d5-73710683cc63 |       |
    6. +------------+--------------------------------------+---------------+--------------+--------------------------------------+-------+
    7. 1 row in set (0.00 sec)

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

    • 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。
    • ：执行 ADD INDEX 操作时，当前已经添加完成的数据行数。
    • START_TIME：DDL 操作的开始时间。
    • STATE：DDL 操作的状态。常见的状态有以下几种：
      • queueing：表示该操作任务已经进入 DDL 任务队列中，但尚未执行，因为还在排队等待前面的 DDL 任务完成。另一种原因可能是执行 DROP 操作后，会变为 none 状态，但是很快会更新为 synced 状态，表示所有 TiDB 实例都已经同步到该状态。
      • running：表示该操作正在执行。
      • synced：表示该操作已经执行成功，且所有 TiDB 实例都已经同步该状态。
      • rollback done：表示该操作执行失败，回滚完成。
      • rollingback：表示该操作执行失败，正在回滚。
      • cancelling：表示正在取消该操作。这个状态只有在用 ADMIN CANCEL DDL JOBS 命令取消 DDL 任务时才会出现。

    示例如下：

    1. ADMIN SHOW DDL JOBS;

    由上述 ADMIN 查询结果可知：

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

    • job_id 为 60 的 JOB_TYPE 显示为 add index，表明正在排队等待 job_id 为 59 的作业完成。当作业 59 完成时，作业 60 的 STATE 将更改为 running。

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

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

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

    2. ADMIN SHOW DDL JOB QUERIES 51;
    1. ADMIN SHOW DDL JOB QUERIES 51;
    2. +--------------------------------------------------------------+
    3. | QUERY                                                        |
    4. +--------------------------------------------------------------+
    5. | CREATE TABLE t1 (id INT NOT NULL PRIMARY KEY auto_increment) |
    6. +--------------------------------------------------------------+
    7. 1 row in set (0.02 sec)

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

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

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

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

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

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