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 for database connections</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 for database connections</h2><blockquote><pre>#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
121
#define SQLITE_DBSTATUS_CACHE_USED 1
122
#define SQLITE_DBSTATUS_SCHEMA_USED 2
123
#define SQLITE_DBSTATUS_STMT_USED 3
124
#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
125
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
126
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
127
#define SQLITE_DBSTATUS_CACHE_HIT 7
128
#define SQLITE_DBSTATUS_CACHE_MISS 8
129
#define SQLITE_DBSTATUS_CACHE_WRITE 9
130
#define SQLITE_DBSTATUS_MAX 9 /* Largest defined DBSTATUS */
131
</pre></blockquote><p>
132
These constants are the available integer "verbs" that can be passed as
133
the second argument to the <a href="../c3ref/db_status.html">sqlite3_db_status()</a> interface.</p>
135
<p>New verbs may be added in future releases of SQLite. Existing verbs
136
might be discontinued. Applications should check the return code from
137
<a href="../c3ref/db_status.html">sqlite3_db_status()</a> to make sure that the call worked.
138
The <a href="../c3ref/db_status.html">sqlite3_db_status()</a> interface will return a non-zero error code
139
if a discontinued or unsupported verb is invoked.</p>
142
<a name="sqlitedbstatuslookasideused"></a>
143
<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
144
<dd>This parameter returns the number of lookaside memory slots currently
145
checked out.</dd></p>
147
<p><a name="sqlitedbstatuslookasidehit"></a>
148
<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
149
<dd>This parameter returns the number malloc attempts that were
150
satisfied using lookaside memory. Only the high-water value is meaningful;
151
the current value is always zero.</p>
153
<p><a name="sqlitedbstatuslookasidemisssize"></a>
155
<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
156
<dd>This parameter returns the number malloc attempts that might have
157
been satisfied using lookaside memory but failed due to the amount of
158
memory requested being larger than the lookaside slot size.
159
Only the high-water value is meaningful;
160
the current value is always zero.</p>
162
<p><a name="sqlitedbstatuslookasidemissfull"></a>
164
<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
165
<dd>This parameter returns the number malloc attempts that might have
166
been satisfied using lookaside memory but failed due to all lookaside
167
memory already being in use.
168
Only the high-water value is meaningful;
169
the current value is always zero.</p>
171
<p><a name="sqlitedbstatuscacheused"></a>
172
<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
173
<dd>This parameter returns the approximate number of of bytes of heap
174
memory used by all pager caches associated with the database connection.
175
The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.</p>
177
<p><a name="sqlitedbstatusschemaused"></a>
178
<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
179
<dd>This parameter returns the approximate number of of bytes of heap
180
memory used to store the schema for all databases associated
181
with the connection - main, temp, and any <a href="../lang_attach.html">ATTACH</a>-ed databases.
182
The full amount of memory used by the schemas is reported, even if the
183
schema memory is shared with other database connections due to
184
<a href="../sharedcache.html">shared cache mode</a> being enabled.
185
The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.</p>
187
<p><a name="sqlitedbstatusstmtused"></a>
188
<dt>SQLITE_DBSTATUS_STMT_USED</dt>
189
<dd>This parameter returns the approximate number of of bytes of heap
190
and lookaside memory used by all prepared statements associated with
191
the database connection.
192
The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
195
<p><a name="sqlitedbstatuscachehit"></a>
196
<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
197
<dd>This parameter returns the number of pager cache hits that have
198
occurred. The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
202
<p><a name="sqlitedbstatuscachemiss"></a>
203
<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
204
<dd>This parameter returns the number of pager cache misses that have
205
occurred. The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
209
<p><a name="sqlitedbstatuscachewrite"></a>
210
<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
211
<dd>This parameter returns the number of dirty cache entries that have
212
been written to disk. Specifically, the number of pages written to the
213
wal file in wal mode databases, or the number of pages written to the
214
database file in rollback mode databases. Any pages written as part of
215
transaction rollback or database recovery operations are not included.
216
If an IO or other error occurs while writing a page to disk, the effect
217
on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined. The
218
highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
221
</p><p>See also lists of
222
<a href="objlist.html">Objects</a>,
223
<a href="constlist.html">Constants</a>, and
224
<a href="funclist.html">Functions</a>.</p>
added
removed
c3ref/c_dbstatus_options.html
