1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
3
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
4
<title>Status Parameters</title>
5
<style type="text/css">
8
font-family: Verdana, sans-serif;
13
a:visited { color: #734559 }
15
.logo { position:absolute; margin:3px; }
31
.toolbar a { color: white; text-decoration: none; padding: 6px 12px; }
32
.toolbar a:visited { color: white; }
33
.toolbar a:hover { color: #044a64; background: white; }
35
.content { margin: 5%; }
36
.content dt { font-weight:bold; }
37
.content dd { margin-bottom: 25px; margin-left:20%; }
38
.content ul { padding:0px; padding-left: 15px; margin:0px; }
41
.se { background: url(../images/se.gif) 100% 100% no-repeat #044a64}
42
.sw { background: url(../images/sw.gif) 0% 100% no-repeat }
43
.ne { background: url(../images/ne.gif) 100% 0% no-repeat }
44
.nw { background: url(../images/nw.gif) 0% 0% no-repeat }
46
/* Things for "fancyformat" documents start here. */
47
.fancy img+p {font-style:italic}
48
.fancy .codeblock i { color: darkblue; }
49
.fancy h1,.fancy h2,.fancy h3,.fancy h4 {font-weight:normal;color:#044a64}
50
.fancy h2 { margin-left: 10px }
51
.fancy h3 { margin-left: 20px }
52
.fancy h4 { margin-left: 30px }
53
.fancy th {white-space:nowrap;text-align:left;border-bottom:solid 1px #444}
54
.fancy th, .fancy td {padding: 0.2em 1ex; vertical-align:top}
55
.fancy #toc a { color: darkblue ; text-decoration: none }
56
.fancy .todo { color: #AA3333 ; font-style : italic }
57
.fancy .todo:before { content: 'TODO:' }
58
.fancy p.todo { border: solid #AA3333 1px; padding: 1ex }
59
.fancy img { display:block; }
60
.fancy :link:hover, .fancy :visited:hover { background: wheat }
61
.fancy p,.fancy ul,.fancy ol { margin: 1em 5ex }
62
.fancy li p { margin: 1em 0 }
63
/* End of "fancyformat" specific rules. */
69
<div><!-- container div to satisfy validator -->
71
<a href="../index.html">
72
<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite Logo"
74
<div><!-- IE hack to prevent disappearing logo--></div>
75
<div class="tagline">Small. Fast. Reliable.<br>Choose any three.</div>
77
<table width=100% style="clear:both"><tr><td>
78
<div class="se"><div class="sw"><div class="ne"><div class="nw">
79
<table width=100% style="padding:0;margin:0;cell-spacing:0"><tr>
82
<a href="../about.html">About</a>
83
<a href="../sitemap.html">Sitemap</a>
84
<a href="../docs.html">Documentation</a>
85
<a href="../download.html">Download</a>
86
<a href="../copyright.html">License</a>
87
<a href="../news.html">News</a>
88
<a href="../support.html">Support</a>
91
gMsg = "Search SQLite Docs..."
92
function entersearch() {
93
var q = document.getElementById("q");
94
if( q.value == gMsg ) { q.value = "" }
95
q.style.color = "black"
96
q.style.fontStyle = "normal"
98
function leavesearch() {
99
var q = document.getElementById("q");
100
if( q.value == "" ) {
102
q.style.color = "#044a64"
103
q.style.fontStyle = "italic"
108
<div style="padding:0 1em 0px 0;white-space:nowrap">
109
<form name=f method="GET" action="http://www.sqlite.org/search">
110
<input id=q name=q type=text
111
onfocus="entersearch()" onblur="leavesearch()" style="width:24ex;padding:1px 1ex; border:solid white 1px; font-size:0.9em ; font-style:italic;color:#044a64;" value="Search SQLite Docs...">
112
<input type=submit value="Go" style="border:solid white 1px;background-color:#044a64;color:white;font-size:0.9em;padding:0 1ex">
116
</div></div></div></div>
118
<div class=startsearch></div>
120
<a href="intro.html"><h2>SQLite C Interface</h2></a><h2>Status Parameters</h2><blockquote><pre>#define SQLITE_STATUS_MEMORY_USED 0
121
#define SQLITE_STATUS_PAGECACHE_USED 1
122
#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
123
#define SQLITE_STATUS_SCRATCH_USED 3
124
#define SQLITE_STATUS_SCRATCH_OVERFLOW 4
125
#define SQLITE_STATUS_MALLOC_SIZE 5
126
#define SQLITE_STATUS_PARSER_STACK 6
127
#define SQLITE_STATUS_PAGECACHE_SIZE 7
128
#define SQLITE_STATUS_SCRATCH_SIZE 8
129
#define SQLITE_STATUS_MALLOC_COUNT 9
130
</pre></blockquote><p>
131
These integer constants designate various run-time status parameters
132
that can be returned by <a href="../c3ref/status.html">sqlite3_status()</a>.</p>
135
<a name="sqlitestatusmemoryused"></a>
136
<dt>SQLITE_STATUS_MEMORY_USED</dt>
137
<dd>This parameter is the current amount of memory checked out
138
using <a href="../c3ref/free.html">sqlite3_malloc()</a>, either directly or indirectly. The
139
figure includes calls made to <a href="../c3ref/free.html">sqlite3_malloc()</a> by the application
140
and internal memory usage by the SQLite library. Scratch memory
141
controlled by <a href="../c3ref/c_config_getmalloc.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a> and auxiliary page-cache
142
memory controlled by <a href="../c3ref/c_config_getmalloc.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a> is not included in
143
this parameter. The amount returned is the sum of the allocation
144
sizes as reported by the xSize method in <a href="../c3ref/mem_methods.html">sqlite3_mem_methods</a>.</dd></p>
146
<p><a name="sqlitestatusmallocsize"></a>
147
<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
148
<dd>This parameter records the largest memory allocation request
149
handed to <a href="../c3ref/free.html">sqlite3_malloc()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a> (or their
150
internal equivalents). Only the value returned in the
151
*pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
152
The value written into the *pCurrent parameter is undefined.</dd></p>
154
<p><a name="sqlitestatusmalloccount"></a>
155
<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
156
<dd>This parameter records the number of separate memory allocations
157
currently checked out.</dd></p>
159
<p><a name="sqlitestatuspagecacheused"></a>
160
<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
161
<dd>This parameter returns the number of pages used out of the
162
<a href="../malloc.html#pagecache">pagecache memory allocator</a> that was configured using
163
<a href="../c3ref/c_config_getmalloc.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>. The
164
value returned is in pages, not in bytes.</dd></p>
166
<p><a name="sqlitestatuspagecacheoverflow"></a>
168
<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
169
<dd>This parameter returns the number of bytes of page cache
170
allocation which could not be satisfied by the <a href="../c3ref/c_config_getmalloc.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>
171
buffer and where forced to overflow to <a href="../c3ref/free.html">sqlite3_malloc()</a>. The
172
returned value includes allocations that overflowed because they
173
where too large (they were larger than the "sz" parameter to
174
<a href="../c3ref/c_config_getmalloc.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>) and allocations that overflowed because
175
no space was left in the page cache.</dd></p>
177
<p><a name="sqlitestatuspagecachesize"></a>
178
<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
179
<dd>This parameter records the largest memory allocation request
180
handed to <a href="../malloc.html#pagecache">pagecache memory allocator</a>. Only the value returned in the
181
*pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
182
The value written into the *pCurrent parameter is undefined.</dd></p>
184
<p><a name="sqlitestatusscratchused"></a>
185
<dt>SQLITE_STATUS_SCRATCH_USED</dt>
186
<dd>This parameter returns the number of allocations used out of the
187
<a href="../malloc.html#scratch">scratch memory allocator</a> configured using
188
<a href="../c3ref/c_config_getmalloc.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a>. The value returned is in allocations, not
189
in bytes. Since a single thread may only have one scratch allocation
190
outstanding at time, this parameter also reports the number of threads
191
using scratch memory at the same time.</dd></p>
193
<p><a name="sqlitestatusscratchoverflow"></a>
194
<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
195
<dd>This parameter returns the number of bytes of scratch memory
196
allocation which could not be satisfied by the <a href="../c3ref/c_config_getmalloc.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a>
197
buffer and where forced to overflow to <a href="../c3ref/free.html">sqlite3_malloc()</a>. The values
198
returned include overflows because the requested allocation was too
199
larger (that is, because the requested allocation was larger than the
200
"sz" parameter to <a href="../c3ref/c_config_getmalloc.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a>) and because no scratch buffer
201
slots were available.
204
<p><a name="sqlitestatusscratchsize"></a>
205
<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
206
<dd>This parameter records the largest memory allocation request
207
handed to <a href="../malloc.html#scratch">scratch memory allocator</a>. Only the value returned in the
208
*pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
209
The value written into the *pCurrent parameter is undefined.</dd></p>
211
<p><a name="sqlitestatusparserstack"></a>
212
<dt>SQLITE_STATUS_PARSER_STACK</dt>
213
<dd>This parameter records the deepest parser stack. It is only
214
meaningful if SQLite is compiled with <a href="../compile.html#yytrackmaxstackdepth">YYTRACKMAXSTACKDEPTH</a>.</dd>
217
<p>New status parameters may be added from time to time.
218
</p><p>See also lists of
219
<a href="objlist.html">Objects</a>,
220
<a href="constlist.html">Constants</a>, and
221
<a href="funclist.html">Functions</a>.</p>
added
removed
c3ref/c_status_malloc_count.html
