Debian Codegraph @

www/c3ref/c_stmtstatus_counter.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>Status Parameters for prepared statements</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_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} SQLITE_STMTSTATUS_AUTOINDEX SQLITE_STMTSTATUS_FILTER_HIT SQLITE_STMTSTATUS_FILTER_MISS SQLITE_STMTSTATUS_FULLSCAN_STEP SQLITE_STMTSTATUS_MEMUSED SQLITE_STMTSTATUS_REPREPARE SQLITE_STMTSTATUS_RUN SQLITE_STMTSTATUS_SORT SQLITE_STMTSTATUS_VM_STEP -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Status Parameters for prepared statements</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
125 #define SQLITE_STMTSTATUS_SORT 2
126 #define SQLITE_STMTSTATUS_AUTOINDEX 3
127 #define SQLITE_STMTSTATUS_VM_STEP 4
128 #define SQLITE_STMTSTATUS_REPREPARE 5
129 #define SQLITE_STMTSTATUS_RUN 6
130 #define SQLITE_STMTSTATUS_FILTER_MISS 7
131 #define SQLITE_STMTSTATUS_FILTER_HIT 8
132 #define SQLITE_STMTSTATUS_MEMUSED 99
133 </pre></blockquote>
134 <p>
135 These preprocessor macros define integer codes that name counter
136 values associated with the <a href="../c3ref/stmt_status.html">sqlite3_stmt_status()</a> interface.
137 The meanings of the various counters are as follows:</p>
138
139 <p><dl>
140 <a name="sqlitestmtstatusfullscanstep"></a>
141 <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
142 <dd>This is the number of times that SQLite has stepped forward in
143 a table as part of a full table scan. Large numbers for this counter
144 may indicate opportunities for performance improvement through
145 careful use of indices.</dd></p>
146
147 <p><a name="sqlitestmtstatussort"></a>
148 <dt>SQLITE_STMTSTATUS_SORT</dt>
149 <dd>This is the number of sort operations that have occurred.
150 A non-zero value in this counter may indicate an opportunity to
151 improve performance through careful use of indices.</dd></p>
152
153 <p><a name="sqlitestmtstatusautoindex"></a>
154 <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
155 <dd>This is the number of rows inserted into transient indices that
156 were created automatically in order to help joins run faster.
157 A non-zero value in this counter may indicate an opportunity to
158 improve performance by adding permanent indices that do not
159 need to be reinitialized each time the statement is run.</dd></p>
160
161 <p><a name="sqlitestmtstatusvmstep"></a>
162 <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
163 <dd>This is the number of virtual machine operations executed
164 by the prepared statement if that number is less than or equal
165 to 2147483647. The number of virtual machine operations can be
166 used as a proxy for the total work done by the prepared statement.
167 If the number of virtual machine operations exceeds 2147483647
168 then the value returned by this statement status code is undefined.</dd></p>
169
170 <p><a name="sqlitestmtstatusreprepare"></a>
171 <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
172 <dd>This is the number of times that the prepare statement has been
173 automatically regenerated due to schema changes or changes to
174 <a href="../lang_expr.html#varparam">bound parameters</a> that might affect the query plan.</dd></p>
175
176 <p><a name="sqlitestmtstatusrun"></a>
177 <dt>SQLITE_STMTSTATUS_RUN</dt>
178 <dd>This is the number of times that the prepared statement has
179 been run. A single "run" for the purposes of this counter is one
180 or more calls to <a href="../c3ref/step.html">sqlite3_step()</a> followed by a call to <a href="../c3ref/reset.html">sqlite3_reset()</a>.
181 The counter is incremented on the first <a href="../c3ref/step.html">sqlite3_step()</a> call of each
182 cycle.</dd></p>
183
184 <p><a name="sqlitestmtstatusfiltermiss"></a>
185
186 <a name="sqlitestmtstatusfilterhit"></a>
187
188 <dt>SQLITE_STMTSTATUS_FILTER_HIT<br>
189 SQLITE_STMTSTATUS_FILTER_MISS</dt>
190 <dd>SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join
191 step was bypassed because a Bloom filter returned not-found. The
192 corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of
193 times that the Bloom filter returned a find, and thus the join step
194 had to be processed as normal.</dd></p>
195
196 <p><a name="sqlitestmtstatusmemused"></a>
197 <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
198 <dd>This is the approximate number of bytes of heap memory
199 used to store the prepared statement. This value is not actually
200 a counter, and so the resetFlg parameter to sqlite3_stmt_status()
201 is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
202 </dd>
203 </dl>
204 </p><p>See also lists of
205 <a href="../c3ref/objlist.html">Objects</a>,
206 <a href="../c3ref/constlist.html">Constants</a>, and
207 <a href="../c3ref/funclist.html">Functions</a>.</p>
208