Debian Codegraph @

www/memstat.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>The SQLITE_MEMSTAT Virtual Table</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 <div class=fancy>
119 <div class=nosearch>
120 <div class="fancy_title">
121 The SQLITE_MEMSTAT Virtual Table
122 </div>
123 </div>
124
125
126
127
128 <h1 id="overview"><span>1. </span>Overview</h1>
129
130 <p>
131 The SQLITE_MEMSTAT extension implements an <a href="vtab.html#epoonlyvtab">eponymous-only virtual table</a> that
132 provides SQL access to the <a href="c3ref/status.html">sqlite3_status64()</a> and
133 <a href="c3ref/db_status.html">sqlite3_db_status()</a> interfaces.
134 </p>
135
136 <p>
137 The SQLITE_STMT extension can also be loaded at run-time
138 by compiling the extension into a shared library or DLL using the source
139 code at <a href="https://sqlite.org/src/file/ext/misc/memstat.c">https://sqlite.org/src/file/ext/misc/memstat.c</a> and following the
140 instructions for how to <a href="loadext.html#build">compile loadable extensions</a>.
141 </p>
142
143 <h1 id="usage"><span>2. </span>Usage</h1>
144
145 <p>
146 The SQLITE_MEMSTAT virtual table is a read-only table that can be
147 queried to determine performance characteristics (primarily the
148 amount of memory being used) of the current instance of SQLite.
149 The SQLITE_MEMSTATE table is essentially a wrapper around the
150 C-language APIs <a href="c3ref/status.html">sqlite3_status64()</a> and <a href="c3ref/db_status.html">sqlite3_db_status()</a>.
151 If the
152 <a href="https://sqlite.org/src/file/ext/misc/memstat.c">memstat.c</a> source
153 file is compiled with the -DSQLITE_ENABLE_ZIPVFS option, then SQLITE_MEMSTAT
154 will also do some <a href="c3ref/file_control.html">file-control</a> calls to extract
155 memory usage information about the
156 <a href="https://www.hwaci.com/sw/sqlite/zipvfs.html">ZIPVFS</a> subsystem,
157 if that subsystem has been licensed, installed, and is in use.
158
159 </p><p>
160 The SQLITE_MEMSTAT table appears to have the following schema:
161
162 </p><div class="codeblock"><pre>CREATE TABLE sqlite_memstat(
163 name TEXT,
164 schema TEXT,
165 value INT,
166 hiwtr INT
167 );
168 </pre></div>
169
170 <p>
171 Each row of the SQLITE_MEMSTAT table corresponds to a single call to
172 one of the <a href="c3ref/status.html">sqlite3_status64()</a> or <a href="c3ref/db_status.html">sqlite3_db_status()</a> interfaces.
173 The NAME column of the row identifies which "verb" was passed to those
174 interfaces. For example, if <a href="c3ref/status.html">sqlite3_status64()</a> is invoked with
175 <a href="c3ref/c_status_malloc_count.html#sqlitestatusmemoryused">SQLITE_STATUS_MEMORY_USED</a>, then the NAME column is 'MEMORY_USED'.
176 Or if <a href="c3ref/db_status.html">sqlite3_db_status()</a> is invoked with <a href="c3ref/c_dbstatus_options.html#sqlitedbstatuscacheused">SQLITE_DBSTATUS_CACHE_USED</a>,
177 then the NAME column is "DB_CACHE_USED".
178
179 </p><p>
180 The SCHEMA column is NULL, except for cases when the <a href="c3ref/file_control.html">sqlite3_file_control()</a>
181 interface is used to interrogate the ZIPVFS backend. As this only happens
182 when the memstat.c module is compiled with -DSQLITE_ENABLE_ZIPVFS and when
183 <a href="https://www.hwaci.com/sw/sqlite/zipvfs.html">ZIPVFS</a> is in use,
184 SCHEMA is usually NULL.
185
186 </p><p>
187 The VALUE and HIWTR columns report the current value of the measure and
188 its "high-water mark". The high-water mark is the highest value ever seen
189 for the measurement, at least since the last reset. The SQLITE_MEMSTAT
190 virtual table does not provide a mechanism for resetting the high-water mark.
191
192 </p><p>
193 Depending on which parameter is being interrogated, one of the VALUE
194 or HIWTR mark measurements might be undefined. For example, only the
195 high-water mark is meaningful for <a href="c3ref/c_status_malloc_count.html#sqlitestatusmallocsize">SQLITE_STATUS_MALLOC_SIZE</a>, and
196 only the current value is meaningful for <a href="c3ref/c_dbstatus_options.html#sqlitedbstatuscacheused">SQLITE_DBSTATUS_CACHE_USED</a>.
197 For rows where one or the other of VALUE or HIWTR is not meaningful,
198 that value is returned as NULL.
199 </p><p align="center"><small><i>This page was last updated on 2025-05-31 13:08:22Z </small></i></p>
200