1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
<!DOCTYPE html>
<html><head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link href="sqlite.css" rel="stylesheet">
<title>EXPLAIN QUERY PLAN</title>
<!-- path= -->
</head>
<body>
<div class=nosearch>
<a href="index.html">
<img class="logo" src="images/sqlite370_banner.gif" alt="SQLite" border="0">
</a>
<div><!-- IE hack to prevent disappearing logo --></div>
<div class="tagline desktoponly">
Small. Fast. Reliable.<br>Choose any three.
</div>
<div class="menu mainmenu">
<ul>
<li><a href="index.html">Home</a>
<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
<li class='wideonly'><a href='about.html'>About</a>
<li class='desktoponly'><a href="docs.html">Documentation</a>
<li class='desktoponly'><a href="download.html">Download</a>
<li class='wideonly'><a href='copyright.html'>License</a>
<li class='desktoponly'><a href="support.html">Support</a>
<li class='desktoponly'><a href="prosupport.html">Purchase</a>
<li class='search' id='search_menubutton'>
<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
</ul>
</div>
<div class="menu submenu" id="submenu">
<ul>
<li><a href='about.html'>About</a>
<li><a href='docs.html'>Documentation</a>
<li><a href='download.html'>Download</a>
<li><a href='support.html'>Support</a>
<li><a href='prosupport.html'>Purchase</a>
</ul>
</div>
<div class="searchmenu" id="searchmenu">
<form method="GET" action="search">
<select name="s" id="searchtype">
<option value="d">Search Documentation</option>
<option value="c">Search Changelog</option>
</select>
<input type="text" name="q" id="searchbox" value="">
<input type="submit" value="Go">
</form>
</div>
</div>
<script>
function toggle_div(nm) {
var w = document.getElementById(nm);
if( w.style.display=="block" ){
w.style.display = "none";
}else{
w.style.display = "block";
}
}
function toggle_search() {
var w = document.getElementById("searchmenu");
if( w.style.display=="block" ){
w.style.display = "none";
} else {
w.style.display = "block";
setTimeout(function(){
document.getElementById("searchbox").focus()
}, 30);
}
}
function div_off(nm){document.getElementById(nm).style.display="none";}
window.onbeforeunload = function(e){div_off("submenu");}
/* Disable the Search feature if we are not operating from CGI, since */
/* Search is accomplished using CGI and will not work without it. */
if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
document.getElementById("search_menubutton").style.display = "none";
}
/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
function hideorshow(btn,obj){
var x = document.getElementById(obj);
var b = document.getElementById(btn);
if( x.style.display!='none' ){
x.style.display = 'none';
b.innerHTML='show';
}else{
x.style.display = '';
b.innerHTML='hide';
}
return false;
}
var antiRobot = 0;
function antiRobotGo(){
if( antiRobot!=3 ) return;
antiRobot = 7;
var j = document.getElementById("mtimelink");
if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
}
function antiRobotDefense(){
document.body.onmousedown=function(){
antiRobot |= 2;
antiRobotGo();
document.body.onmousedown=null;
}
document.body.onmousemove=function(){
antiRobot |= 2;
antiRobotGo();
document.body.onmousemove=null;
}
setTimeout(function(){
antiRobot |= 1;
antiRobotGo();
}, 100)
antiRobotGo();
}
antiRobotDefense();
</script>
<div class=fancy>
<div class=nosearch>
<div class="fancy_title">
EXPLAIN QUERY PLAN
</div>
<div class="fancy_toc">
<a onclick="toggle_toc()">
<span class="fancy_toc_mark" id="toc_mk">►</span>
Table Of Contents
</a>
<div id="toc_sub"><div class="fancy-toc1"><a href="#the_explain_query_plan_command">1. The EXPLAIN QUERY PLAN Command</a></div>
<div class="fancy-toc2"><a href="#table_and_index_scans">1.1. Table and Index Scans</a></div>
<div class="fancy-toc2"><a href="#temporary_sorting_b_trees">1.2. Temporary Sorting B-Trees</a></div>
<div class="fancy-toc2"><a href="#subqueries">1.3. Subqueries</a></div>
<div class="fancy-toc2"><a href="#compound_queries">1.4. Compound Queries</a></div>
</div>
</div>
<script>
function toggle_toc(){
var sub = document.getElementById("toc_sub")
var mk = document.getElementById("toc_mk")
if( sub.style.display!="block" ){
sub.style.display = "block";
mk.innerHTML = "▼";
} else {
sub.style.display = "none";
mk.innerHTML = "►";
}
}
</script>
</div>
<h1 id="the_explain_query_plan_command"><span>1. </span>The EXPLAIN QUERY PLAN Command</h1>
<p style="margin-left:10ex;margin-right:10ex">
<b>Warning:</b> The data returned by the EXPLAIN QUERY PLAN command is
intended for interactive debugging only. The output format may change
between SQLite releases. Applications should not depend on the output
format of the EXPLAIN QUERY PLAN command.
</p><p style="margin-left:10ex;margin-right:10ex">
<b>Alert:</b> As warned above, the EXPLAIN QUERY PLAN output format did
change substantially with the version 3.24.0 release (2018-06-04).
Additional minor changes occurred in version 3.36.0 (2021-06-18).
Further changes are possible in subsequent releases.
</p><p>The <a href="lang_explain.html">EXPLAIN QUERY PLAN</a> SQL command is used to obtain a high-level
description of the strategy or plan that SQLite uses to implement a specific
SQL query. Most significantly, EXPLAIN QUERY PLAN reports on the way in
which the query uses database indices. This document is a guide to
understanding and interpreting the EXPLAIN QUERY PLAN output. Background
information is available separately:
</p><ul>
<li> A primer on <a href="howitworks.html">How SQLite Works</a>.
</li><li> Notes on the <a href="optoverview.html">query optimizer</a>.
</li><li> How <a href="queryplanner.html">indexing</a> works.
</li><li> The <a href="queryplanner-ng.html">next generation query planner</a>.
</li></ul>
<p>A query plan is represented as a tree.
In raw form, as returned by <a href="c3ref/step.html">sqlite3_step()</a>, each node of the tree
consists of four fields: An integer node id, an integer parent id,
an auxiliary integer field that is not currently used, and a description
of the node.
The entire tree is therefore a table with four columns and zero or more
rows.
The <a href="cli.html">command-line shell</a> will usually intercept this table and renders
it as an ASCII-art graph for more convenient viewing. To disable the
shells automatic graph rendering and to display EXPLAIN QUERY PLAN
output in its tabular format, run the command ".explain off" to set
the "EXPLAIN formatting mode" to off. To restore automatic graph rendering,
run ".explain auto". You can see the current "EXPLAIN formatting mode"
setting using the ".show" command.
</p><p>One can also set the <a href="cli.html">CLI</a> into automatic EXPLAIN QUERY PLAN mode
using the ".eqp on" command:
</p><div class="codeblock"><pre>sqlite> .eqp on
</pre></div>
<p> In automatic EXPLAIN QUERY PLAN mode, the shell automatically runs
a separate EXPLAIN QUERY PLAN query for each statement you enter and
displays the result before actually running the query. Use the
".eqp off" command to turn automatic EXPLAIN QUERY PLAN mode back off.
</p><p>EXPLAIN QUERY PLAN is most useful on a SELECT statement,
but may also appear with other statements that read data from database
tables (e.g. UPDATE, DELETE, INSERT INTO ... SELECT).
</p><h2 id="table_and_index_scans"><span>1.1. </span>Table and Index Scans</h2>
<p>
When processing a SELECT (or other) statement, SQLite may retrieve data from
database tables in a variety of ways. It may scan through all the records in
a table (a full-table scan), scan a contiguous subset of the records in a
table based on the rowid index, scan a contiguous subset of the entries in a
database <a href="lang_createtable.html">index</a>, or use a combination of the above strategies
in a single scan. The various ways in which SQLite may retrieve data from a
table or index are described in detail <a href="queryplanner.html#searching">here</a>.
</p><p>
For each table read by the query, the output of EXPLAIN QUERY
PLAN includes a record for which the value in the "detail" column begins
with either "SCAN" or "SEARCH". "SCAN" is used for a full-table scan,
including cases where SQLite iterates through all records in a table
in an order defined by an index. "SEARCH" indicates that only a subset of
the table rows are visited. Each SCAN or SEARCH record includes the
following information:
</p><ul>
<li> The name of the table, view, or subquery that data is read from.
</li><li> Whether or not an index or <a href="optoverview.html#autoindex">automatic index</a> is used.
</li><li> Whether or not the <a href="queryplanner.html#covidx">covering index</a> optimization applies.
</li><li> Which terms of the WHERE clause are used for indexing.
</li></ul>
<p>
For example, the following EXPLAIN QUERY PLAN command operates on a SELECT
statement that is implemented by performing a full-table scan on table t1:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT a, b FROM t1 WHERE a=1;
QUERY PLAN
`--SCAN t1
</pre></div>
<p>
The example above shows
SQLite picking full-table scan will visit all rows in the table.
If the query were able to use an index, then the
SCAN/SEARCH record would include the name of the index and, for a
SEARCH record, an indication of how the subset of rows visited is
identified. For example:
</p><div class="codeblock"><pre>sqlite> CREATE INDEX i1 ON t1(a);
sqlite> EXPLAIN QUERY PLAN SELECT a, b FROM t1 WHERE a=1;
QUERY PLAN
`--SEARCH t1 USING INDEX i1 (a=?)
</pre></div>
<p>
The previous example, SQLite uses index "i1" to optimize
a WHERE clause term of the form (a=?) - in this case "a=1".
The previous example could not use a <a href="queryplanner.html#covidx">covering index</a>, but the following
example can, and that fact is reflected in the output:
</p><div class="codeblock"><pre>sqlite> CREATE INDEX i2 ON t1(a, b);
sqlite> EXPLAIN QUERY PLAN SELECT a, b FROM t1 WHERE a=1;
QUERY PLAN
`--SEARCH t1 USING COVERING INDEX i2 (a=?)
</pre></div>
<p>
All joins in SQLite are <a href="optoverview.html#joins">implemented using nested scans</a>. When a
SELECT query that features a join is analyzed using EXPLAIN QUERY PLAN, one
SCAN or SEARCH record is output for each nested loop. For example:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT t1.*, t2.* FROM t1, t2 WHERE t1.a=1 AND t1.b>2;
QUERY PLAN
|--SEARCH t1 USING INDEX i2 (a=? AND b>?)
`--SCAN t2
</pre></div>
<p>
The order of the entries indicates the nesting order. In
this case, the scan of table t1 using index i2 is the outer loop (since it
appears first)
and the full-table scan of table t2 is the inner loop (since it appears
last).
In the following example, the positions of t1 and t2 in the FROM
clause of the SELECT are reversed. The query strategy remains the same.
The output from EXPLAIN QUERY PLAN shows how the query is actually
evaluated, not how it is specified in the SQL statement.
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT t1.*, t2.* FROM t2, t1 WHERE t1.a=1 AND t1.b>2;
QUERY PLAN
|--SEARCH t1 USING INDEX i2 (a=? AND b>?)
`--SCAN t2
</pre></div>
<a name="or-opt"></a>
<p>
If the WHERE clause of a query contains an OR expression, then SQLite might
use the <a href="queryplanner.html#or_in_where">"OR by union"</a> strategy (also known as the
<a href="optoverview.html#or_opt">OR optimization</a>). In this case there will be single top-level record
for the search, with two sub-records, one for each index:
</p><div class="codeblock"><pre>sqlite> CREATE INDEX i3 ON t1(b);
sqlite> EXPLAIN QUERY PLAN SELECT * FROM t1 WHERE a=1 OR b=2;
QUERY PLAN
`--MULTI-INDEX OR
|--SEARCH t1 USING COVERING INDEX i2 (a=?)
`--SEARCH t1 USING INDEX i3 (b=?)
</pre></div>
<h2 id="temporary_sorting_b_trees"><span>1.2. </span>Temporary Sorting B-Trees</h2>
<p>
If a SELECT query contains an ORDER BY, GROUP BY or DISTINCT clause,
SQLite may need to use a temporary b-tree structure to sort the output
rows. Or, it might <a href="queryplanner.html#sorting">use an index</a>. Using an index is
almost always much more efficient than performing a sort.
If a temporary b-tree is required, a record is added to the EXPLAIN
QUERY PLAN output with the "detail" field set to a string value of
the form "USE TEMP B-TREE FOR xxx", where xxx is one of "ORDER BY",
"GROUP BY" or "DISTINCT". For example:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT c, d FROM t2 ORDER BY c;
QUERY PLAN
|--SCAN t2
`--USE TEMP B-TREE FOR ORDER BY
</pre></div>
<p>
In this case using the temporary b-tree can be avoided by creating an index
on t2(c), as follows:
</p><div class="codeblock"><pre>sqlite> CREATE INDEX i4 ON t2(c);
sqlite> EXPLAIN QUERY PLAN SELECT c, d FROM t2 ORDER BY c;
QUERY PLAN
`--SCAN t2 USING INDEX i4
</pre></div>
<h2 id="subqueries"><span>1.3. </span>Subqueries</h2>
<p>
In all the examples above, there has only been a single SELECT statement.
If a query contains sub-selects, those are shown as being children of
the outer SELECT. For example:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT (SELECT b FROM t1 WHERE a=0), (SELECT a FROM t1 WHERE b=t2.c) FROM t2;
|--SCAN TABLE t2 USING COVERING INDEX i4
|--SCALAR SUBQUERY
| `--SEARCH t1 USING COVERING INDEX i2 (a=?)
`--CORRELATED SCALAR SUBQUERY
`--SEARCH t1 USING INDEX i3 (b=?)
</pre></div>
<p>
The example above contains two "SCALAR" subqueries. The subqueries
are SCALAR in the sense that they return a single value - a one-row,
one-column table. If the actual query returns more than that, then
only the first column of the first row is used.
</p><p>
The first subquery above is constant with respect to the outer query.
The value for the first subquery can be computed once and then reused
for each row of the outer SELECT. The second subquery, however, is
"CORRELATED". The value of the second subquery changes depending
on values in the current row of the outer query. Hence, the second
subquery must be run once for each output row in the outer SELECT.
</p><p>
Unless the <a href="optoverview.html#flattening">flattening optimization</a> is applied, if a subquery appears in
the FROM clause of a SELECT statement, SQLite can either run the subquery and
stores the results in a temporary table, or it can run the subquery as a
co-routine. The following query is an example of the latter. The subquery
is run by a co-routine. The outer query blocks whenever it needs another
row of input from the subquery. Control switches to the co-routine which
produces the desired output row, then control switches back to the main
routine which continues processing.
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT count(*)
> FROM (SELECT max(b) AS x FROM t1 GROUP BY a) AS qqq
> GROUP BY x;
QUERY PLAN
|--CO-ROUTINE qqq
| `--SCAN t1 USING COVERING INDEX i2
|--SCAN qqqq
`--USE TEMP B-TREE FOR GROUP BY
</pre></div>
<p>
If the <a href="optoverview.html#flattening">flattening optimization</a> is used on a subquery in the FROM clause
of a SELECT statement, that effectively merges the subquery into the outer
query. The output of EXPLAIN QUERY PLAN reflects this, as in the following
example:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT * FROM (SELECT * FROM t2 WHERE c=1) AS t3, t1;
QUERY PLAN
|--SEARCH t2 USING INDEX i4 (c=?)
`--SCAN t1
</pre></div>
<p>
If the content of a subquery might need to be visited more than once, then
the use of a co-routine is undesirable, as the co-routine would then have to
compute the data more than once. And if the subquery cannot be flattened,
that means the subquery must be manifested into a transient table.
</p><div class="codeblock"><pre>sqlite> SELECT * FROM
> (SELECT * FROM t1 WHERE a=1 ORDER BY b LIMIT 2) AS x,
> (SELECT * FROM t2 WHERE c=1 ORDER BY d LIMIT 2) AS y;
QUERY PLAN
|--MATERIALIZE x
| `--SEARCH t1 USING COVERING INDEX i2 (a=?)
|--MATERIALIZE y
| |--SEARCH t2 USING INDEX i4 (c=?)
| `--USE TEMP B-TREE FOR ORDER BY
|--SCAN x
`--SCAN y
</pre></div>
<h2 id="compound_queries"><span>1.4. </span>Compound Queries</h2>
<p>
Each component query of a <a href="lang_select.html#compound">compound query</a> (UNION, UNION ALL, EXCEPT or
INTERSECT) is assigned computed separately and is given its own line in
the EXPLAIN QUERY PLAN output.
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT a FROM t1 UNION SELECT c FROM t2;
QUERY PLAN
`--COMPOUND QUERY
|--LEFT-MOST SUBQUERY
| `--SCAN t1 USING COVERING INDEX i1
`--UNION USING TEMP B-TREE
`--SCAN t2 USING COVERING INDEX i4
</pre></div>
<p>
The "USING TEMP B-TREE" clause in the above output indicates that a
temporary b-tree structure is used to implement the UNION of the results
of the two sub-selects. An alternative method of computing a compound
is to run each subquery as a co-routine, arrange for their outputs to
appear in sorted order, and merge the results together. When the query
planner chooses this latter approach, the EXPLAIN QUERY PLAN output
looks like this:
</p><div class="codeblock"><pre>sqlite> EXPLAIN QUERY PLAN SELECT a FROM t1 EXCEPT SELECT d FROM t2 ORDER BY 1;
QUERY PLAN
`--MERGE (EXCEPT)
|--LEFT
| `--SCAN t1 USING COVERING INDEX i1
`--RIGHT
|--SCAN t2
`--USE TEMP B-TREE FOR ORDER BY
</pre></div>
<p align="center"><small><i>This page last modified on <a href="https://sqlite.org/docsrc/honeypot" id="mtimelink" data-href="https://sqlite.org/docsrc/finfo/pages/eqp.in?m=719c38ad7e">2022-01-08 05:02:57</a> UTC </small></i></p>
|
