Debian Codegraph @

www/c3ref/stmt_scanstatus.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>Prepared Statement Scan Status</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_scanstatus sqlite3_stmt_scanstatus_v2 -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Prepared Statement Scan Status</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_stmt_scanstatus(
125 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
126 int idx, /* Index of loop to report on */
127 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
128 void *pOut /* Result written here */
129 );
130 int sqlite3_stmt_scanstatus_v2(
131 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
132 int idx, /* Index of loop to report on */
133 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
134 int flags, /* Mask of flags defined below */
135 void *pOut /* Result written here */
136 );
137 </pre></blockquote>
138 <p>
139 These interfaces return information about the predicted and measured
140 performance for pStmt. Advanced applications can use this
141 interface to compare the predicted and the measured performance and
142 issue warnings and/or rerun <a href="../lang_analyze.html">ANALYZE</a> if discrepancies are found.</p>
143
144 <p>Since this interface is expected to be rarely used, it is only
145 available if SQLite is compiled using the <a href="../compile.html#enable_stmt_scanstatus">SQLITE_ENABLE_STMT_SCANSTATUS</a>
146 compile-time option.</p>
147
148 <p>The "iScanStatusOp" parameter determines which status information to return.
149 The "iScanStatusOp" must be one of the <a href="../c3ref/c_scanstat_est.html">scanstatus options</a> or the behavior
150 of this interface is undefined. The requested measurement is written into
151 a variable pointed to by the "pOut" parameter.</p>
152
153 <p>The "flags" parameter must be passed a mask of flags. At present only
154 one flag is defined - <a href="../c3ref/c_scanstat_complex.html">SQLITE_SCANSTAT_COMPLEX</a>. If SQLITE_SCANSTAT_COMPLEX
155 is specified, then status information is available for all elements
156 of a query plan that are reported by "<a href="../eqp.html">EXPLAIN QUERY PLAN</a>" output. If
157 SQLITE_SCANSTAT_COMPLEX is not specified, then only query plan elements
158 that correspond to query loops (the "SCAN..." and "SEARCH..." elements of
159 the EXPLAIN QUERY PLAN output) are available. Invoking API
160 sqlite3_stmt_scanstatus() is equivalent to calling
161 sqlite3_stmt_scanstatus_v2() with a zeroed flags parameter.</p>
162
163 <p>Parameter "idx" identifies the specific query element to retrieve statistics
164 for. Query elements are numbered starting from zero. A value of -1 may
165 retrieve statistics for the entire query. If idx is out of range
166 - less than -1 or greater than or equal to the total number of query
167 elements used to implement the statement - a non-zero value is returned and
168 the variable that pOut points to is unchanged.</p>
169
170 <p>See also: <a href="../c3ref/stmt_scanstatus_reset.html">sqlite3_stmt_scanstatus_reset()</a> and the
171 <a href="../bytecodevtab.html#nexec">nexec and ncycle</a> columns of the <a href="../bytecodevtab.html">bytecode virtual table</a>.
172 </p><p>See also lists of
173 <a href="../c3ref/objlist.html">Objects</a>,
174 <a href="../c3ref/constlist.html">Constants</a>, and
175 <a href="../c3ref/funclist.html">Functions</a>.</p>
176