1 files changed, 192 insertions, 0 deletions
diff --git a/www/c3ref/hard_heap_limit64.html b/www/c3ref/hard_heap_limit64.html
new file mode 100644
index 0000000..7b5a320
--- /dev/null
+++ b/www/c3ref/hard_heap_limit64.html
@@ -0,0 +1,192 @@
+<!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>Impose A Limit On Heap Size</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;
+}
+var antiRobot = 0;
+function antiRobotGo(){
+if( antiRobot!=3 ) return;
+antiRobot = 7;
+var j = document.getElementById("mtimelink");
+if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
+}
+function antiRobotDefense(){
+document.body.onmousedown=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousedown=null;
+}
+document.body.onmousemove=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousemove=null;
+}
+setTimeout(function(){
+antiRobot |= 1;
+antiRobotGo();
+}, 100)
+antiRobotGo();
+}
+antiRobotDefense();
+</script>
+<!-- keywords: sqlite3_hard_heap_limit64 sqlite3_soft_heap_limit64 -->
+<div class=nosearch>
+<a href="intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Impose A Limit On Heap Size</h2>
+</div>
+<blockquote><pre>
+sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
+sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
+</pre></blockquote>
+<p>
+These interfaces impose limits on the amount of heap memory that will be
+by all database connections within a single process.</p>
+
+<p>The sqlite3_soft_heap_limit64() interface sets and/or queries the
+soft limit on the amount of heap memory that may be allocated by SQLite.
+SQLite strives to keep heap memory utilization below the soft heap
+limit by reducing the number of pages held in the page cache
+as heap memory usages approaches the limit.
+The soft heap limit is "soft" because even though SQLite strives to stay
+below the limit, it will exceed the limit rather than generate
+an <a href="../rescode.html#nomem">SQLITE_NOMEM</a> error.  In other words, the soft heap limit
+is advisory only.</p>
+
+<p>The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
+N bytes on the amount of memory that will be allocated.  The
+sqlite3_hard_heap_limit64(N) interface is similar to
+sqlite3_soft_heap_limit64(N) except that memory allocations will fail
+when the hard heap limit is reached.</p>
+
+<p>The return value from both sqlite3_soft_heap_limit64() and
+sqlite3_hard_heap_limit64() is the size of
+the heap limit prior to the call, or negative in the case of an
+error.  If the argument N is negative
+then no change is made to the heap limit.  Hence, the current
+size of heap limits can be determined by invoking
+sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).</p>
+
+<p>Setting the heap limits to zero disables the heap limiter mechanism.</p>
+
+<p>The soft heap limit may not be greater than the hard heap limit.
+If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
+is invoked with a value of N that is greater than the hard heap limit,
+the soft heap limit is set to the value of the hard heap limit.
+The soft heap limit is automatically enabled whenever the hard heap
+limit is enabled. When sqlite3_hard_heap_limit64(N) is invoked and
+the soft heap limit is outside the range of 1..N, then the soft heap
+limit is set to N.  Invoking sqlite3_soft_heap_limit64(0) when the
+hard heap limit is enabled makes the soft heap limit equal to the
+hard heap limit.</p>
+
+<p>The memory allocation limits can also be adjusted using
+<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>
+
+<p>The heap limits are not enforced in the current implementation
+if one or more of following conditions are true:</p>
+
+<p><ul>
+<li> The limit value is set to zero.
+<li> Memory accounting is disabled using a combination of the
+<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
+the <a href="../compile.html#default_memstatus">SQLITE_DEFAULT_MEMSTATUS</a> compile-time option.
+<li> An alternative page cache implementation is specified using
+<a href="../c3ref/config.html">sqlite3_config</a>(<a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpcache2">SQLITE_CONFIG_PCACHE2</a>,...).
+<li> The page cache allocates from its own memory pool supplied
+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
+from the heap.
+</ul></p>
+
+<p>The circumstances under which SQLite will enforce the heap limits may
+changes in future releases of SQLite.
+</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>
+