Debian Codegraph @

www/c3ref/hard_heap_limit64.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>Impose A Limit On Heap Size</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 <!-- keywords: sqlite3_hard_heap_limit64 sqlite3_soft_heap_limit64 -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Impose A Limit On Heap Size</h2>
122 </div>
123 <blockquote><pre>
124 sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
125 sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
126 </pre></blockquote>
127 <p>
128 These interfaces impose limits on the amount of heap memory that will be
129 used by all database connections within a single process.</p>
130
131 <p>The sqlite3_soft_heap_limit64() interface sets and/or queries the
132 soft limit on the amount of heap memory that may be allocated by SQLite.
133 SQLite strives to keep heap memory utilization below the soft heap
134 limit by reducing the number of pages held in the page cache
135 as heap memory usages approaches the limit.
136 The soft heap limit is "soft" because even though SQLite strives to stay
137 below the limit, it will exceed the limit rather than generate
138 an <a href="../rescode.html#nomem">SQLITE_NOMEM</a> error. In other words, the soft heap limit
139 is advisory only.</p>
140
141 <p>The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
142 N bytes on the amount of memory that will be allocated. The
143 sqlite3_hard_heap_limit64(N) interface is similar to
144 sqlite3_soft_heap_limit64(N) except that memory allocations will fail
145 when the hard heap limit is reached.</p>
146
147 <p>The return value from both sqlite3_soft_heap_limit64() and
148 sqlite3_hard_heap_limit64() is the size of
149 the heap limit prior to the call, or negative in the case of an
150 error. If the argument N is negative
151 then no change is made to the heap limit. Hence, the current
152 size of heap limits can be determined by invoking
153 sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).</p>
154
155 <p>Setting the heap limits to zero disables the heap limiter mechanism.</p>
156
157 <p>The soft heap limit may not be greater than the hard heap limit.
158 If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
159 is invoked with a value of N that is greater than the hard heap limit,
160 the soft heap limit is set to the value of the hard heap limit.
161 The soft heap limit is automatically enabled whenever the hard heap
162 limit is enabled. When sqlite3_hard_heap_limit64(N) is invoked and
163 the soft heap limit is outside the range of 1..N, then the soft heap
164 limit is set to N. Invoking sqlite3_soft_heap_limit64(0) when the
165 hard heap limit is enabled makes the soft heap limit equal to the
166 hard heap limit.</p>
167
168 <p>The memory allocation limits can also be adjusted using
169 <a href="../pragma.html#pragma_soft_heap_limit">PRAGMA soft_heap_limit</a> and <a href="../pragma.html#pragma_hard_heap_limit">PRAGMA hard_heap_limit</a>.</p>
170
171 <p>The heap limits are not enforced in the current implementation
172 if one or more of following conditions are true:</p>
173
174 <p><ul>
175 <li> The limit value is set to zero.
176 <li> Memory accounting is disabled using a combination of the
177 <a href="../c3ref/config.html">sqlite3_config</a>(<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigmemstatus">SQLITE_CONFIG_MEMSTATUS</a>,...) start-time option and
178 the <a href="../compile.html#default_memstatus">SQLITE_DEFAULT_MEMSTATUS</a> compile-time option.
179 <li> An alternative page cache implementation is specified using
180 <a href="../c3ref/config.html">sqlite3_config</a>(<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpcache2">SQLITE_CONFIG_PCACHE2</a>,...).
181 <li> The page cache allocates from its own memory pool supplied
182 by <a href="../c3ref/config.html">sqlite3_config</a>(<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>,...) rather than
183 from the heap.
184 </ul></p>
185
186 <p>The circumstances under which SQLite will enforce the heap limits may
187 change in future releases of SQLite.
188 </p><p>See also lists of
189 <a href="../c3ref/objlist.html">Objects</a>,
190 <a href="../c3ref/constlist.html">Constants</a>, and
191 <a href="../c3ref/funclist.html">Functions</a>.</p>
192