EXPLAIN
EXPLAIN
ステートメントは、クエリを実行せずにクエリの実行計画を示します。これにEXPLAIN ANALYZE
付加すると、クエリが実行されます。 EXPLAIN
の出力が予期した結果と一致しない場合は、クエリ内の各テーブルに対してANALYZE TABLE
を実行することを検討してください。
ステートメントDESC
とDESCRIBE
は、このステートメントの別名です。 EXPLAIN <tableName>
の別の使用法はSHOW [FULL] COLUMNS FROM
に記載されています。
TiDB はEXPLAIN [options] FOR CONNECTION connection_id
ステートメントをサポートします。ただし、このステートメントは MySQL のEXPLAIN FOR
ステートメントとは異なります。詳細については、 EXPLAIN FOR CONNECTION
を参照してください。
あらすじ
- ExplainSym
- ExplainStmt
- ExplainableStmt
ExplainSym ::=
'EXPLAIN'
| 'DESCRIBE'
| 'DESC'
ExplainStmt ::=
ExplainSym ( TableName ColumnName? | 'ANALYZE'? ExplainableStmt | 'FOR' 'CONNECTION' NUM | 'FORMAT' '=' ( stringLit | ExplainFormatType ) ( 'FOR' 'CONNECTION' NUM | ExplainableStmt ) )
ExplainableStmt ::=
SelectStmt
| DeleteFromStmt
| UpdateStmt
| InsertIntoStmt
| ReplaceIntoStmt
| UnionStmt
EXPLAIN
出力形式
注記:
MySQL クライアントを使用して TiDB に接続する場合、行の折り返しを行わずに出力結果をより明確に読み取るには、
pager less -S
コマンドを使用できます。次に、EXPLAIN
結果が出力された後、キーボードの右矢印→ボタンを押して出力を水平方向にスクロールします。
注記:
返された実行プランでは、
IndexJoin
およびApply
演算子のすべてのプローブ側子ノードについて、v6.4.0 以降のestRows
の意味は v6.4.0 以前とは異なります。詳細についてはTiDB クエリ実行計画の概要を参照してください。
現在、TiDB のEXPLAIN
はid
、 estRows
、 task
、 access object
、 operator info
の 5 つの列を出力します。実行プラン内の各演算子はこれらの属性によって記述され、 EXPLAIN
の出力の各行が演算子を記述します。各属性の説明は次のとおりです。
属性名 | 説明 |
---|---|
ID | オペレーター ID は、実行プラン全体におけるオペレーターの一意の識別子です。 TiDB 2.1 では、ID はオペレーターのツリー構造を表示する形式になっています。データは子ノードから親ノードに流れます。各オペレーターに 1 つだけの親ノード。 |
estRows | オペレーターが出力すると予想される行数。この数値は、統計とオペレーターのロジックに従って推定されます。 estRows は、TiDB 4.0 の以前のバージョンではcount と呼ばれていました。 |
タスク | オペレーターが属するタスクのタイプ。現在、実行計画は 2 つのタスクに分割されています。1 つは tidb-server 上で実行されるrootタスク、もう 1 つは TiKV またはTiFlash上で並行して実行されるcopタスクです。タスク レベルでの実行計画のトポロジは、ルート タスクの後に多くのcop タスクが続くというものです。 root タスクは、cop タスクの出力を入力として使用します。 cop タスクは、TiDB が TiKV またはTiFlashにプッシュダウンするタスクを指します。各copタスクはTiKVクラスタまたはTiFlashクラスタに分散され、複数のプロセスによって実行されます。 |
アクセスオブジェクト | オペレータがアクセスするデータ項目の情報。情報には、 table 、 partition 、およびindex (存在する場合) が含まれます。このような情報を持っているのは、データに直接アクセスするオペレーターだけです。 |
オペレーター情報 | オペレーターに関するその他の情報。各演算子のoperator info は異なります。次の例を参照してください。 |
例
EXPLAIN SELECT 1;
+-------------------+---------+------+---------------+---------------+
| id | estRows | task | access object | operator info |
+-------------------+---------+------+---------------+---------------+
| Projection_3 | 1.00 | root | | 1->Column#1 |
| └─TableDual_4 | 1.00 | root | | rows:1 |
+-------------------+---------+------+---------------+---------------+
2 rows in set (0.00 sec)
CREATE TABLE t1 (id INT NOT NULL PRIMARY KEY AUTO_INCREMENT, c1 INT NOT NULL);
Query OK, 0 rows affected (0.10 sec)
INSERT INTO t1 (c1) VALUES (1), (2), (3);
Query OK, 3 rows affected (0.02 sec)
Records: 3 Duplicates: 0 Warnings: 0
EXPLAIN SELECT * FROM t1 WHERE id = 1;
+-------------+---------+------+---------------+---------------+
| id | estRows | task | access object | operator info |
+-------------+---------+------+---------------+---------------+
| Point_Get_1 | 1.00 | root | table:t1 | handle:1 |
+-------------+---------+------+---------------+---------------+
1 row in set (0.00 sec)
DESC SELECT * FROM t1 WHERE id = 1;
+-------------+---------+------+---------------+---------------+
| id | estRows | task | access object | operator info |
+-------------+---------+------+---------------+---------------+
| Point_Get_1 | 1.00 | root | table:t1 | handle:1 |
+-------------+---------+------+---------------+---------------+
1 row in set (0.00 sec)
DESCRIBE SELECT * FROM t1 WHERE id = 1;
+-------------+---------+------+---------------+---------------+
| id | estRows | task | access object | operator info |
+-------------+---------+------+---------------+---------------+
| Point_Get_1 | 1.00 | root | table:t1 | handle:1 |
+-------------+---------+------+---------------+---------------+
1 row in set (0.00 sec)
EXPLAIN INSERT INTO t1 (c1) VALUES (4);
+----------+---------+------+---------------+---------------+
| id | estRows | task | access object | operator info |
+----------+---------+------+---------------+---------------+
| Insert_1 | N/A | root | | N/A |
+----------+---------+------+---------------+---------------+
1 row in set (0.00 sec)
EXPLAIN UPDATE t1 SET c1=5 WHERE c1=3;
+---------------------------+---------+-----------+---------------+--------------------------------+
| id | estRows | task | access object | operator info |
+---------------------------+---------+-----------+---------------+--------------------------------+
| Update_4 | N/A | root | | N/A |
| └─TableReader_8 | 0.00 | root | | data:Selection_7 |
| └─Selection_7 | 0.00 | cop[tikv] | | eq(test.t1.c1, 3) |
| └─TableFullScan_6 | 3.00 | cop[tikv] | table:t1 | keep order:false, stats:pseudo |
+---------------------------+---------+-----------+---------------+--------------------------------+
4 rows in set (0.00 sec)
EXPLAIN DELETE FROM t1 WHERE c1=3;
+---------------------------+---------+-----------+---------------+--------------------------------+
| id | estRows | task | access object | operator info |
+---------------------------+---------+-----------+---------------+--------------------------------+
| Delete_4 | N/A | root | | N/A |
| └─TableReader_8 | 0.00 | root | | data:Selection_7 |
| └─Selection_7 | 0.00 | cop[tikv] | | eq(test.t1.c1, 3) |
| └─TableFullScan_6 | 3.00 | cop[tikv] | table:t1 | keep order:false, stats:pseudo |
+---------------------------+---------+-----------+---------------+--------------------------------+
4 rows in set (0.01 sec)
EXPLAIN
出力の形式を指定するには、 FORMAT = xxx
構文を使用できます。現在、TiDB は次の形式をサポートしています。
フォーマット | 説明 |
---|---|
指定されていない | 形式が指定されていない場合、 EXPLAIN デフォルトの形式row を使用します。 |
brief | EXPLAIN ステートメントの出力のオペレーター ID は、 FORMAT 指定しない場合に比べて簡略化されます。 |
dot | EXPLAIN ステートメントは DOT 実行プランを出力します。これは、( graphviz パッケージ内の) dot プログラムを通じて PNG ファイルを生成するために使用できます。 |
row | EXPLAIN ステートメントは結果を表形式で出力します。詳細については、 クエリ実行計画を理解する参照してください。 |
tidb_json | EXPLAIN ステートメントは、実行プランを JSON で出力し、オペレーター情報を JSON 配列に保存します。 |
verbose | EXPLAIN ステートメントは結果をrow 形式で出力し、結果にはクエリの推定コストを表すestCost 列が追加されます。この形式の使用方法の詳細については、 SQL計画管理を参照してください。 |
plan_cache | EXPLAIN ステートメントは、 プランキャッシュ情報を警告として含むrow 形式で結果を出力します。 |
- brief
- DotGraph
- JSON
以下はFORMAT
EXPLAIN
の"brief"
である場合の例です。
EXPLAIN FORMAT = "brief" DELETE FROM t1 WHERE c1 = 3;
+-------------------------+---------+-----------+---------------+--------------------------------+
| id | estRows | task | access object | operator info |
+-------------------------+---------+-----------+---------------+--------------------------------+
| Delete | N/A | root | | N/A |
| └─TableReader | 0.00 | root | | data:Selection |
| └─Selection | 0.00 | cop[tikv] | | eq(test.t1.c1, 3) |
| └─TableFullScan | 3.00 | cop[tikv] | table:t1 | keep order:false, stats:pseudo |
+-------------------------+---------+-----------+---------------+--------------------------------+
4 rows in set (0.001 sec)
MySQL の標準結果形式に加えて、TiDB は DotGraph もサポートしており、次の例のようにFORMAT = "dot"
を指定する必要があります。
CREATE TABLE t(a bigint, b bigint);
EXPLAIN format = "dot" SELECT A.a, B.b FROM t A JOIN t B ON A.a > B.b WHERE A.a < 10;
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dot contents |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
digraph Projection_8 {
subgraph cluster8{
node [style=filled, color=lightgrey]
color=black
label = "root"
"Projection_8" -> "HashJoin_9"
"HashJoin_9" -> "TableReader_13"
"HashJoin_9" -> "Selection_14"
"Selection_14" -> "TableReader_17"
}
subgraph cluster12{
node [style=filled, color=lightgrey]
color=black
label = "cop"
"Selection_12" -> "TableFullScan_11"
}
subgraph cluster16{
node [style=filled, color=lightgrey]
color=black
label = "cop"
"Selection_16" -> "TableFullScan_15"
}
"TableReader_13" -> "Selection_12"
"TableReader_17" -> "Selection_16"
}
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)
コンピュータにdot
プログラムがある場合は、次の方法を使用して PNG ファイルを生成できます。
dot xx.dot -T png -O
The xx.dot is the result returned by the above statement.
コンピュータにdot
プログラムがない場合は、結果をこのウェブサイトにコピーして樹形図を取得します。
JSON で出力を取得するには、 EXPLAIN
ステートメントにFORMAT = "tidb_json"
を指定します。以下は例です。
CREATE TABLE t(id int primary key, a int, b int, key(a));
EXPLAIN FORMAT = "tidb_json" SELECT id FROM t WHERE a = 1;
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| TiDB_JSON |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| [
{
"id": "Projection_4",
"estRows": "10.00",
"taskType": "root",
"operatorInfo": "test.t.id",
"subOperators": [
{
"id": "IndexReader_6",
"estRows": "10.00",
"taskType": "root",
"operatorInfo": "index:IndexRangeScan_5",
"subOperators": [
{
"id": "IndexRangeScan_5",
"estRows": "10.00",
"taskType": "cop[tikv]",
"accessObject": "table:t, index:a(a)",
"operatorInfo": "range:[1,1], keep order:false, stats:pseudo"
}
]
}
]
}
]
|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.01 sec)
出力では、 id
、 estRows
、 taskType
、 accessObject
、およびoperatorInfo
は、デフォルト形式の列と同じ意味を持ちます。 subOperators
はサブノードを格納する配列です。サブノードのフィールドと意味は親ノードと同じです。フィールドが欠落している場合は、そのフィールドが空であることを意味します。
MySQLの互換性
EXPLAIN
の形式と TiDB の潜在的な実行プランは両方とも MySQL とは大幅に異なります。- TiDB は
FORMAT=JSON
またはFORMAT=TREE
オプションをサポートしていません。 - TiDB の
FORMAT=tidb_json
は、デフォルトのEXPLAIN
の結果の JSON 形式の出力です。形式とフィールドは、MySQL のFORMAT=JSON
出力とは異なります。
EXPLAIN FOR CONNECTION
EXPLAIN FOR CONNECTION
、接続内で現在実行されている SQL クエリまたは最後に実行された SQL クエリの実行プランを取得するために使用されます。出力形式はEXPLAIN
と同じです。ただし、TiDB でのEXPLAIN FOR CONNECTION
の実装は MySQL での実装とは異なります。それらの違い (出力形式を除く) を以下に示します。
- 接続がスリープ状態の場合、MySQL は空の結果を返しますが、TiDB は最後に実行されたクエリ プランを返します。
- 現在のセッションの実行プランを取得しようとすると、MySQL はエラーを返しますが、TiDB は通常どおり結果を返します。
- MySQL では、ログイン ユーザーがクエリ対象の接続と同じであるか、ログイン ユーザーが
PROCESS
権限を持っている必要があります。一方、TiDB では、ログイン ユーザーがクエリ対象の接続と同じであるか、ログイン ユーザーがSUPER
権限を持っている必要があります。