188 lines
7.7 KiB
HTML
188 lines
7.7 KiB
HTML
<!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</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;
|
|
}
|
|
</script>
|
|
</div>
|
|
<!-- keywords: SQLITE_STATUS_MALLOC_COUNT SQLITE_STATUS_MALLOC_SIZE SQLITE_STATUS_MEMORY_USED SQLITE_STATUS_PAGECACHE_OVERFLOW SQLITE_STATUS_PAGECACHE_SIZE SQLITE_STATUS_PAGECACHE_USED SQLITE_STATUS_PARSER_STACK SQLITE_STATUS_SCRATCH_OVERFLOW SQLITE_STATUS_SCRATCH_SIZE SQLITE_STATUS_SCRATCH_USED {status parameters} -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Status Parameters</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
#define SQLITE_STATUS_MEMORY_USED 0
|
|
#define SQLITE_STATUS_PAGECACHE_USED 1
|
|
#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
|
|
#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
|
|
#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
|
|
#define SQLITE_STATUS_MALLOC_SIZE 5
|
|
#define SQLITE_STATUS_PARSER_STACK 6
|
|
#define SQLITE_STATUS_PAGECACHE_SIZE 7
|
|
#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
|
|
#define SQLITE_STATUS_MALLOC_COUNT 9
|
|
</pre></blockquote>
|
|
<p>
|
|
These integer constants designate various run-time status parameters
|
|
that can be returned by <a href="../c3ref/status.html">sqlite3_status()</a>.</p>
|
|
|
|
<p><dl>
|
|
<a name="sqlitestatusmemoryused"></a>
|
|
<dt>SQLITE_STATUS_MEMORY_USED</dt>
|
|
<dd>This parameter is the current amount of memory checked out
|
|
using <a href="../c3ref/free.html">sqlite3_malloc()</a>, either directly or indirectly. The
|
|
figure includes calls made to <a href="../c3ref/free.html">sqlite3_malloc()</a> by the application
|
|
and internal memory usage by the SQLite library. Auxiliary page-cache
|
|
memory controlled by <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a> is not included in
|
|
this parameter. The amount returned is the sum of the allocation
|
|
sizes as reported by the xSize method in <a href="../c3ref/mem_methods.html">sqlite3_mem_methods</a>.</dd></p>
|
|
|
|
<p><a name="sqlitestatusmallocsize"></a>
|
|
<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
|
|
<dd>This parameter records the largest memory allocation request
|
|
handed to <a href="../c3ref/free.html">sqlite3_malloc()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a> (or their
|
|
internal equivalents). Only the value returned in the
|
|
*pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
|
|
The value written into the *pCurrent parameter is undefined.</dd></p>
|
|
|
|
<p><a name="sqlitestatusmalloccount"></a>
|
|
<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
|
|
<dd>This parameter records the number of separate memory allocations
|
|
currently checked out.</dd></p>
|
|
|
|
<p><a name="sqlitestatuspagecacheused"></a>
|
|
<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
|
|
<dd>This parameter returns the number of pages used out of the
|
|
<a href="../malloc.html#pagecache">pagecache memory allocator</a> that was configured using
|
|
<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>. The
|
|
value returned is in pages, not in bytes.</dd></p>
|
|
|
|
<p><a name="sqlitestatuspagecacheoverflow"></a>
|
|
|
|
<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
|
|
<dd>This parameter returns the number of bytes of page cache
|
|
allocation which could not be satisfied by the <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>
|
|
buffer and where forced to overflow to <a href="../c3ref/free.html">sqlite3_malloc()</a>. The
|
|
returned value includes allocations that overflowed because they
|
|
where too large (they were larger than the "sz" parameter to
|
|
<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>) and allocations that overflowed because
|
|
no space was left in the page cache.</dd></p>
|
|
|
|
<p><a name="sqlitestatuspagecachesize"></a>
|
|
<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
|
|
<dd>This parameter records the largest memory allocation request
|
|
handed to the <a href="../malloc.html#pagecache">pagecache memory allocator</a>. Only the value returned in the
|
|
*pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
|
|
The value written into the *pCurrent parameter is undefined.</dd></p>
|
|
|
|
<p><a name="sqlitestatusscratchused"></a>
|
|
<dt>SQLITE_STATUS_SCRATCH_USED</dt>
|
|
<dd>No longer used.</dd></p>
|
|
|
|
<p><a name="sqlitestatusscratchoverflow"></a>
|
|
<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
|
|
<dd>No longer used.</dd></p>
|
|
|
|
<p><a name="sqlitestatusscratchsize"></a>
|
|
<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
|
|
<dd>No longer used.</dd></p>
|
|
|
|
<p><a name="sqlitestatusparserstack"></a>
|
|
<dt>SQLITE_STATUS_PARSER_STACK</dt>
|
|
<dd>The *pHighwater parameter records the deepest parser stack.
|
|
The *pCurrent value is undefined. The *pHighwater value is only
|
|
meaningful if SQLite is compiled with <a href="../compile.html#yytrackmaxstackdepth">YYTRACKMAXSTACKDEPTH</a>.</dd>
|
|
</dl></p>
|
|
|
|
<p>New status parameters may be added from time to time.
|
|
</p><p>See also lists of
|
|
<a href="objlist.html">Objects</a>,
|
|
<a href="constlist.html">Constants</a>, and
|
|
<a href="funclist.html">Functions</a>.</p>
|