Documentation Source Text

Check-in [c6125c2ae7]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix documentation for the ".explain auto" command.
Downloads: Tarball | ZIP archive
Timelines: family | ancestors | descendants | both | branch-3.30
Files: files | file ages | folders
SHA3-256: c6125c2ae7b177fd030014fc4b1a9c48475f3060b884363c61fed7053bfe49ac
User & Date: drh 2019-11-01 23:58:28.068
Context
2019-11-02
12:10
Fix typo on the download page. (check-in: 037e7f6d68 user: drh tags: branch-3.30)
2019-11-01
23:58
Fix documentation for the ".explain auto" command. (check-in: c6125c2ae7 user: drh tags: branch-3.30)
2019-10-22
13:26
Fix a typo on the whentouse.html page. (check-in: 8b5ba0e2b1 user: drh tags: trunk)
Changes
Unified Diff Ignore Whitespace Patch
Changes to pages/eqp.in.
35
36
37
38
39
40
41
42
43
44
45



46
47
48
49
50
51
52
In raw form, as returned by [sqlite3_step()], 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 [command-line shell] will usually intercept this table and renders
it as an ASCII-art graph for more convenient viewing.  To defeat the
shells automatic graph rendering, simply include extra white space
in between any of the "EXPLAIN", "QUERY", and/or "PLAN" keywords and
the output will appear in a (less helpful) tabular format.




<p>One can also set the [CLI] into automatic EXPLAIN QUERY PLAN mode
using the ".eqp on" command:

<codeblock>
     sqlite&gt; .eqp on
</codeblock>







|
|
<
|
>
>
>







35
36
37
38
39
40
41
42
43

44
45
46
47
48
49
50
51
52
53
54
In raw form, as returned by [sqlite3_step()], 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 [command-line shell] 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>One can also set the [CLI] into automatic EXPLAIN QUERY PLAN mode
using the ".eqp on" command:

<codeblock>
     sqlite&gt; .eqp on
</codeblock>