Debian Codegraph @

www/c3ref/stmt_explain.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta name="viewport" content="width=device-width, initial-scale=1.0">
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
5 <link href="../sqlite.css" rel="stylesheet">
6 <title>Change The EXPLAIN Setting For A Prepared Statement</title>
7 <!-- path=../ -->
8 </head>
9 <body>
10 <div class=nosearch>
11 <a href="../index.html">
12 <img class="logo" src="../images/sqlite370_banner.svg" alt="SQLite" border="0">
13 </a>
14 <div><!-- IE hack to prevent disappearing logo --></div>
15 <div class="tagline desktoponly">
16 Small. Fast. Reliable.<br>Choose any three.
17 </div>
18 <div class="menu mainmenu">
19 <ul>
20 <li><a href="../index.html">Home</a>
21 <li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
22 <li class='wideonly'><a href='../about.html'>About</a>
23 <li class='desktoponly'><a href="../docs.html">Documentation</a>
24 <li class='desktoponly'><a href="../download.html">Download</a>
25 <li class='wideonly'><a href='../copyright.html'>License</a>
26 <li class='desktoponly'><a href="../support.html">Support</a>
27 <li class='desktoponly'><a href="../prosupport.html">Purchase</a>
28 <li class='search' id='search_menubutton'>
29 <a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
30 </ul>
31 </div>
32 <div class="menu submenu" id="submenu">
33 <ul>
34 <li><a href='../about.html'>About</a>
35 <li><a href='../docs.html'>Documentation</a>
36 <li><a href='../download.html'>Download</a>
37 <li><a href='../support.html'>Support</a>
38 <li><a href='../prosupport.html'>Purchase</a>
39 </ul>
40 </div>
41 <div class="searchmenu" id="searchmenu">
42 <form method="GET" action="../search">
43 <select name="s" id="searchtype">
44 <option value="d">Search Documentation</option>
45 <option value="c">Search Changelog</option>
46 </select>
47 <input type="text" name="q" id="searchbox" value="">
48 <input type="submit" value="Go">
49 </form>
50 </div>
51 </div>
52 <script>
53 function toggle_div(nm) {
54 var w = document.getElementById(nm);
55 if( w.style.display=="block" ){
56 w.style.display = "none";
57 }else{
58 w.style.display = "block";
59 }
60 }
61 function toggle_search() {
62 var w = document.getElementById("searchmenu");
63 if( w.style.display=="block" ){
64 w.style.display = "none";
65 } else {
66 w.style.display = "block";
67 setTimeout(function(){
68 document.getElementById("searchbox").focus()
69 }, 30);
70 }
71 }
72 function div_off(nm){document.getElementById(nm).style.display="none";}
73 window.onbeforeunload = function(e){div_off("submenu");}
74 /* Disable the Search feature if we are not operating from CGI, since */
75 /* Search is accomplished using CGI and will not work without it. */
76 if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
77 document.getElementById("search_menubutton").style.display = "none";
78 }
79 /* Used by the Hide/Show button beside syntax diagrams, to toggle the */
80 function hideorshow(btn,obj){
81 var x = document.getElementById(obj);
82 var b = document.getElementById(btn);
83 if( x.style.display!='none' ){
84 x.style.display = 'none';
85 b.innerHTML='show';
86 }else{
87 x.style.display = '';
88 b.innerHTML='hide';
89 }
90 return false;
91 }
92 var antiRobot = 0;
93 function antiRobotGo(){
94 if( antiRobot!=3 ) return;
95 antiRobot = 7;
96 var j = document.getElementById("mtimelink");
97 if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
98 }
99 function antiRobotDefense(){
100 document.body.onmousedown=function(){
101 antiRobot |= 2;
102 antiRobotGo();
103 document.body.onmousedown=null;
104 }
105 document.body.onmousemove=function(){
106 antiRobot |= 2;
107 antiRobotGo();
108 document.body.onmousemove=null;
109 }
110 setTimeout(function(){
111 antiRobot |= 1;
112 antiRobotGo();
113 }, 100)
114 antiRobotGo();
115 }
116 antiRobotDefense();
117 </script>
118 <!-- keywords: sqlite3_stmt_explain -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Change The EXPLAIN Setting For A Prepared Statement</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_stmt_explain(sqlite3_stmt *pStmt, int eMode);
125 </pre></blockquote>
126 <p>
127 The sqlite3_stmt_explain(S,E) interface changes the EXPLAIN
128 setting for <a href="../c3ref/stmt.html">prepared statement</a> S. If E is zero, then S becomes
129 a normal prepared statement. If E is 1, then S behaves as if
130 its SQL text began with "<a href="../lang_explain.html">EXPLAIN</a>". If E is 2, then S behaves as if
131 its SQL text began with "<a href="../eqp.html">EXPLAIN QUERY PLAN</a>".</p>
132
133 <p>Calling sqlite3_stmt_explain(S,E) might cause S to be reprepared.
134 SQLite tries to avoid a reprepare, but a reprepare might be necessary
135 on the first transition into EXPLAIN or EXPLAIN QUERY PLAN mode.</p>
136
137 <p>Because of the potential need to reprepare, a call to
138 sqlite3_stmt_explain(S,E) will fail with SQLITE_ERROR if S cannot be
139 reprepared because it was created using <a href="../c3ref/prepare.html">sqlite3_prepare()</a> instead of
140 the newer <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a> or <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a> interfaces and
141 hence has no saved SQL text with which to reprepare.</p>
142
143 <p>Changing the explain setting for a prepared statement does not change
144 the original SQL text for the statement. Hence, if the SQL text originally
145 began with EXPLAIN or EXPLAIN QUERY PLAN, but sqlite3_stmt_explain(S,0)
146 is called to convert the statement into an ordinary statement, the EXPLAIN
147 or EXPLAIN QUERY PLAN keywords will still appear in the sqlite3_sql(S)
148 output, even though the statement now acts like a normal SQL statement.</p>
149
150 <p>This routine returns SQLITE_OK if the explain mode is successfully
151 changed, or an error code if the explain mode could not be changed.
152 The explain mode cannot be changed while a statement is active.
153 Hence, it is good practice to call <a href="../c3ref/reset.html">sqlite3_reset(S)</a>
154 immediately prior to calling sqlite3_stmt_explain(S,E).
155 </p><p>See also lists of
156 <a href="../c3ref/objlist.html">Objects</a>,
157 <a href="../c3ref/constlist.html">Constants</a>, and
158 <a href="../c3ref/funclist.html">Functions</a>.</p>
159