summaryrefslogtreecommitdiffstats
path: root/www/c3ref/c_stmtstatus_counter.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/c3ref/c_stmtstatus_counter.html')
-rw-r--r--www/c3ref/c_stmtstatus_counter.html208
1 files changed, 208 insertions, 0 deletions
diff --git a/www/c3ref/c_stmtstatus_counter.html b/www/c3ref/c_stmtstatus_counter.html
new file mode 100644
index 0000000..1f0ebe4
--- /dev/null
+++ b/www/c3ref/c_stmtstatus_counter.html
@@ -0,0 +1,208 @@
+<!DOCTYPE html>
+<html><head>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<link href="../sqlite.css" rel="stylesheet">
+<title>Status Parameters for prepared statements</title>
+<!-- path=../ -->
+</head>
+<body>
+<div class=nosearch>
+<a href="../index.html">
+<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
+</a>
+<div><!-- IE hack to prevent disappearing logo --></div>
+<div class="tagline desktoponly">
+Small. Fast. Reliable.<br>Choose any three.
+</div>
+<div class="menu mainmenu">
+<ul>
+<li><a href="../index.html">Home</a>
+<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
+<li class='wideonly'><a href='../about.html'>About</a>
+<li class='desktoponly'><a href="../docs.html">Documentation</a>
+<li class='desktoponly'><a href="../download.html">Download</a>
+<li class='wideonly'><a href='../copyright.html'>License</a>
+<li class='desktoponly'><a href="../support.html">Support</a>
+<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
+<li class='search' id='search_menubutton'>
+<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
+</ul>
+</div>
+<div class="menu submenu" id="submenu">
+<ul>
+<li><a href='../about.html'>About</a>
+<li><a href='../docs.html'>Documentation</a>
+<li><a href='../download.html'>Download</a>
+<li><a href='../support.html'>Support</a>
+<li><a href='../prosupport.html'>Purchase</a>
+</ul>
+</div>
+<div class="searchmenu" id="searchmenu">
+<form method="GET" action="../search">
+<select name="s" id="searchtype">
+<option value="d">Search Documentation</option>
+<option value="c">Search Changelog</option>
+</select>
+<input type="text" name="q" id="searchbox" value="">
+<input type="submit" value="Go">
+</form>
+</div>
+</div>
+<script>
+function toggle_div(nm) {
+var w = document.getElementById(nm);
+if( w.style.display=="block" ){
+w.style.display = "none";
+}else{
+w.style.display = "block";
+}
+}
+function toggle_search() {
+var w = document.getElementById("searchmenu");
+if( w.style.display=="block" ){
+w.style.display = "none";
+} else {
+w.style.display = "block";
+setTimeout(function(){
+document.getElementById("searchbox").focus()
+}, 30);
+}
+}
+function div_off(nm){document.getElementById(nm).style.display="none";}
+window.onbeforeunload = function(e){div_off("submenu");}
+/* Disable the Search feature if we are not operating from CGI, since */
+/* Search is accomplished using CGI and will not work without it. */
+if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
+document.getElementById("search_menubutton").style.display = "none";
+}
+/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
+function hideorshow(btn,obj){
+var x = document.getElementById(obj);
+var b = document.getElementById(btn);
+if( x.style.display!='none' ){
+x.style.display = 'none';
+b.innerHTML='show';
+}else{
+x.style.display = '';
+b.innerHTML='hide';
+}
+return false;
+}
+var antiRobot = 0;
+function antiRobotGo(){
+if( antiRobot!=3 ) return;
+antiRobot = 7;
+var j = document.getElementById("mtimelink");
+if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
+}
+function antiRobotDefense(){
+document.body.onmousedown=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousedown=null;
+}
+document.body.onmousemove=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousemove=null;
+}
+setTimeout(function(){
+antiRobot |= 1;
+antiRobotGo();
+}, 100)
+antiRobotGo();
+}
+antiRobotDefense();
+</script>
+<!-- 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 -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Status Parameters for prepared statements</h2>
+</div>
+<blockquote><pre>
+#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
+#define SQLITE_STMTSTATUS_SORT 2
+#define SQLITE_STMTSTATUS_AUTOINDEX 3
+#define SQLITE_STMTSTATUS_VM_STEP 4
+#define SQLITE_STMTSTATUS_REPREPARE 5
+#define SQLITE_STMTSTATUS_RUN 6
+#define SQLITE_STMTSTATUS_FILTER_MISS 7
+#define SQLITE_STMTSTATUS_FILTER_HIT 8
+#define SQLITE_STMTSTATUS_MEMUSED 99
+</pre></blockquote>
+<p>
+These preprocessor macros define integer codes that name counter
+values associated with the <a href="../c3ref/stmt_status.html">sqlite3_stmt_status()</a> interface.
+The meanings of the various counters are as follows:</p>
+
+<p><dl>
+<a name="sqlitestmtstatusfullscanstep"></a>
+ <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
+<dd>This is the number of times that SQLite has stepped forward in
+a table as part of a full table scan. Large numbers for this counter
+may indicate opportunities for performance improvement through
+careful use of indices.</dd></p>
+
+<p><a name="sqlitestmtstatussort"></a>
+ <dt>SQLITE_STMTSTATUS_SORT</dt>
+<dd>This is the number of sort operations that have occurred.
+A non-zero value in this counter may indicate an opportunity to
+improvement performance through careful use of indices.</dd></p>
+
+<p><a name="sqlitestmtstatusautoindex"></a>
+ <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
+<dd>This is the number of rows inserted into transient indices that
+were created automatically in order to help joins run faster.
+A non-zero value in this counter may indicate an opportunity to
+improvement performance by adding permanent indices that do not
+need to be reinitialized each time the statement is run.</dd></p>
+
+<p><a name="sqlitestmtstatusvmstep"></a>
+ <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
+<dd>This is the number of virtual machine operations executed
+by the prepared statement if that number is less than or equal
+to 2147483647. The number of virtual machine operations can be
+used as a proxy for the total work done by the prepared statement.
+If the number of virtual machine operations exceeds 2147483647
+then the value returned by this statement status code is undefined.</p>
+
+<p><a name="sqlitestmtstatusreprepare"></a>
+ <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
+<dd>This is the number of times that the prepare statement has been
+automatically regenerated due to schema changes or changes to
+<a href="../lang_expr.html#varparam">bound parameters</a> that might affect the query plan.</p>
+
+<p><a name="sqlitestmtstatusrun"></a>
+ <dt>SQLITE_STMTSTATUS_RUN</dt>
+<dd>This is the number of times that the prepared statement has
+been run. A single "run" for the purposes of this counter is one
+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>.
+The counter is incremented on the first <a href="../c3ref/step.html">sqlite3_step()</a> call of each
+cycle.</p>
+
+<p><a name="sqlitestmtstatusfiltermiss"></a>
+
+<a name="sqlitestmtstatusfilterhit"></a>
+
+<dt>SQLITE_STMTSTATUS_FILTER_HIT<br>
+SQLITE_STMTSTATUS_FILTER_MISS</dt>
+<dd>SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join
+step was bypassed because a Bloom filter returned not-found. The
+corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of
+times that the Bloom filter returned a find, and thus the join step
+had to be processed as normal.</p>
+
+<p><a name="sqlitestmtstatusmemused"></a>
+ <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
+<dd>This is the approximate number of bytes of heap memory
+used to store the prepared statement. This value is not actually
+a counter, and so the resetFlg parameter to sqlite3_stmt_status()
+is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
+</dd>
+</dl>
+</p><p>See also lists of
+ <a href="../c3ref/objlist.html">Objects</a>,
+ <a href="../c3ref/constlist.html">Constants</a>, and
+ <a href="../c3ref/funclist.html">Functions</a>.</p>
+