Debian Codegraph @

www/c3ref/c_scanstat_est.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 Opcodes</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: SQLITE_SCANSTAT_EST SQLITE_SCANSTAT_EXPLAIN SQLITE_SCANSTAT_NAME SQLITE_SCANSTAT_NCYCLE SQLITE_SCANSTAT_NLOOP SQLITE_SCANSTAT_NVISIT SQLITE_SCANSTAT_PARENTID SQLITE_SCANSTAT_SELECTID {scanstatus options} -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Prepared Statement Scan Status Opcodes</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_SCANSTAT_NLOOP 0
125 #define SQLITE_SCANSTAT_NVISIT 1
126 #define SQLITE_SCANSTAT_EST 2
127 #define SQLITE_SCANSTAT_NAME 3
128 #define SQLITE_SCANSTAT_EXPLAIN 4
129 #define SQLITE_SCANSTAT_SELECTID 5
130 #define SQLITE_SCANSTAT_PARENTID 6
131 #define SQLITE_SCANSTAT_NCYCLE 7
132 </pre></blockquote>
133 <p>
134 The following constants can be used for the T parameter to the
135 <a href="../c3ref/stmt_scanstatus.html">sqlite3_stmt_scanstatus(S,X,T,V)</a> interface. Each constant designates a
136 different metric for sqlite3_stmt_scanstatus() to return.</p>
137
138 <p>When the value returned to V is a string, space to hold that string is
139 managed by the prepared statement S and will be automatically freed when
140 S is finalized.</p>
141
142 <p>Not all values are available for all query elements. When a value is
143 not available, the output variable is set to -1 if the value is numeric,
144 or to NULL if it is a string (SQLITE_SCANSTAT_NAME).</p>
145
146 <p><dl>
147 <a name="sqlitescanstatnloop"></a>
148 <dt>SQLITE_SCANSTAT_NLOOP</dt>
149 <dd>The <a href="../c3ref/int64.html">sqlite3_int64</a> variable pointed to by the V parameter will be
150 set to the total number of times that the X-th loop has run.</dd></p>
151
152 <p><a name="sqlitescanstatnvisit"></a>
153 <dt>SQLITE_SCANSTAT_NVISIT</dt>
154 <dd>The <a href="../c3ref/int64.html">sqlite3_int64</a> variable pointed to by the V parameter will be set
155 to the total number of rows examined by all iterations of the X-th loop.</dd></p>
156
157 <p><a name="sqlitescanstatest"></a>
158 <dt>SQLITE_SCANSTAT_EST</dt>
159 <dd>The "double" variable pointed to by the V parameter will be set to the
160 query planner's estimate for the average number of rows output from each
161 iteration of the X-th loop. If the query planner's estimate was accurate,
162 then this value will approximate the quotient NVISIT/NLOOP and the
163 product of this value for all prior loops with the same SELECTID will
164 be the NLOOP value for the current loop.</dd></p>
165
166 <p><a name="sqlitescanstatname"></a>
167 <dt>SQLITE_SCANSTAT_NAME</dt>
168 <dd>The "const char *" variable pointed to by the V parameter will be set
169 to a zero-terminated UTF-8 string containing the name of the index or table
170 used for the X-th loop.</dd></p>
171
172 <p><a name="sqlitescanstatexplain"></a>
173 <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
174 <dd>The "const char *" variable pointed to by the V parameter will be set
175 to a zero-terminated UTF-8 string containing the <a href="../eqp.html">EXPLAIN QUERY PLAN</a>
176 description for the X-th loop.</dd></p>
177
178 <p><a name="sqlitescanstatselectid"></a>
179 <dt>SQLITE_SCANSTAT_SELECTID</dt>
180 <dd>The "int" variable pointed to by the V parameter will be set to the
181 id for the X-th query plan element. The id value is unique within the
182 statement. The select-id is the same value as is output in the first
183 column of an <a href="../eqp.html">EXPLAIN QUERY PLAN</a> query.</dd></p>
184
185 <p><a name="sqlitescanstatparentid"></a>
186 <dt>SQLITE_SCANSTAT_PARENTID</dt>
187 <dd>The "int" variable pointed to by the V parameter will be set to the
188 id of the parent of the current query element, if applicable, or
189 to zero if the query element has no parent. This is the same value as
190 returned in the second column of an <a href="../eqp.html">EXPLAIN QUERY PLAN</a> query.</dd></p>
191
192 <p><a name="sqlitescanstatncycle"></a>
193 <dt>SQLITE_SCANSTAT_NCYCLE</dt>
194 <dd>The sqlite3_int64 output value is set to the number of cycles,
195 according to the processor time-stamp counter, that elapsed while the
196 query element was being processed. This value is not available for
197 all query elements - if it is unavailable the output variable is
198 set to -1.</dd>
199 </dl>
200 </p><p>See also lists of
201 <a href="../c3ref/objlist.html">Objects</a>,
202 <a href="../c3ref/constlist.html">Constants</a>, and
203 <a href="../c3ref/funclist.html">Functions</a>.</p>
204