| 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>SQLite Requirements</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 |
|
| 119 |
|
| 120 |
|
| 121 |
<h2>1.0 About SQLite Requirements</h2> |
| 122 |
|
| 123 |
|
| 124 |
<ul> |
| 125 |
<li><p> |
| 126 |
Requirements consist of excerpts from the documentation. |
| 127 |
A requirement is usually a one-sentence excerpt but might be a sentence |
| 128 |
fragment, multiple sentences, a table, or a GIF image of a bubble syntax |
| 129 |
diagram. |
| 130 |
|
| 131 |
<li><p> |
| 132 |
Requirements are written in conversational English and without the |
| 133 |
modal auxiliary verb "shall". This grows out of the fact that requirements |
| 134 |
are taken from the documentation. The intended audience for the |
| 135 |
documentation is application programmers. "Shall" language is appropriate |
| 136 |
when the audience consists of contract specialists, QA auditors, and lawyers, |
| 137 |
but it interferes with comprehension when the audience is application |
| 138 |
programmers. Hence, in order to best serve the intended audience, the |
| 139 |
"shall" language is omitted. |
| 140 |
|
| 141 |
<li><p> |
| 142 |
Requirements are sufficiently detailed and precise to permit a 100% compatible |
| 143 |
clean-room reimplementation of SQLite. |
| 144 |
|
| 145 |
<li><p> |
| 146 |
The word "requirement" in common English usage implies an ordering: that |
| 147 |
the requirement comes before the implementation. |
| 148 |
But there is no such ordering with SQLite requirements. |
| 149 |
What are called "requirements" in SQLite are better described as |
| 150 |
"testable statements of truth about the behavior of the system". |
| 151 |
|
| 152 |
<li><p> |
| 153 |
Every testable statement of truth about SQLite in the |
| 154 |
documentation becomes a requirement. |
| 155 |
|
| 156 |
<li><p> |
| 157 |
Requirement numbers are the MD5 hash of the requirement itself. |
| 158 |
<ol type="a"> |
| 159 |
<li><p>Requirements are inherently immutable, since any change |
| 160 |
to the requirement results in a completely different requirement number. |
| 161 |
|
| 162 |
<li><p>For text requirements, the text is normalized prior to computing the |
| 163 |
MD5 hash: |
| 164 |
<ul> |
| 165 |
<li>Remove all leading and trailing whitespace. |
| 166 |
<li>Convert all internal whitespace sequences to a single space character. |
| 167 |
<li>Convert "&lt;" to "<", "&gt;" to ">", |
| 168 |
"&#91;" to "[", "&#93;" to "]", and |
| 169 |
"&amp;" to "&". |
| 170 |
</ul> |
| 171 |
<li><p>For GIF syntax diagram requirements, the MD5 hash is computed over |
| 172 |
the entire content of the GIF image file. |
| 173 |
|
| 174 |
<li><p>The MD5 hash is expressed in human-readable form as follows: |
| 175 |
<blockquote><b>R-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i><b>-</b><i>N</i></blockquote> |
| 176 |
Where each <i>N</i> is a 5-digit number between 00000 and 65536 that |
| 177 |
represents 16 bits of the 128-bit MD5 hash. |
| 178 |
|
| 179 |
<li><p>Requirements may be referenced by any unique prefix of their |
| 180 |
complete requirement number. |
| 181 |
</ol> |
| 182 |
|
| 183 |
<p><li> |
| 184 |
Individual text requirements are identified in the |
| 185 |
documentation as text between "<b>^</b>" and the first period or |
| 186 |
full-stop ("<b>.</b>") |
| 187 |
or as text between "<b>^(</b>" and "<b>)^</b>". |
| 188 |
<ol type="a"> |
| 189 |
<li><p> |
| 190 |
Text requirements are automatically extracted from the documentation by scripts |
| 191 |
that run as part of the documentation build process. |
| 192 |
|
| 193 |
<li><p> |
| 194 |
After requirements have been extracted from the documentation, the requirement |
| 195 |
markers "<b>^</b>", "<b>^(</b>", and "<b>)^</b>" are removed |
| 196 |
from the documentation text. This is done automatically by the documentation |
| 197 |
build scripts. |
| 198 |
|
| 199 |
<li><p> |
| 200 |
To avoid collisions with these requirements delimiters, "^" characters that |
| 201 |
are part of the text of a requirement or that are otherwise found in the |
| 202 |
documentation, should be coded as "&#94;". |
| 203 |
</ol> |
| 204 |
|
| 205 |
<p><li> |
| 206 |
Individual GIF syntax diagram requirements are identified in the |
| 207 |
documentation as HTML image markup of the |
| 208 |
form |
| 209 |
<blockquote><b> |
| 210 |
<img alt="syntax diagram </b><i>NAME</i><b>" src="</b><i>FILE</i><b>"> |
| 211 |
</b></blockquote> |
| 212 |
Where <i>NAME</i> is the name of the syntax diagram and <i>FILE</i> is |
| 213 |
the name of the GIF file containing the syntax diagram. |
| 214 |
<ol type="a"> |
| 215 |
<li><p> |
| 216 |
Syntax diagram requirements are automatically extracted from the |
| 217 |
documentation by scripts |
| 218 |
that run as part of the documentation build process. |
| 219 |
|
| 220 |
<li><p> |
| 221 |
The GIF file is the requirement, not the HTML markup that references the |
| 222 |
GIF file nor the diagram name. |
| 223 |
</ol> |
| 224 |
|
| 225 |
<li><p> |
| 226 |
The documentation that contains the |
| 227 |
requirement text is generated by scripts that take their input |
| 228 |
from files in the documentation fossil repository as well as |
| 229 |
comments in the source code. |
| 230 |
|
| 231 |
</ul> |
| 232 |
|
| 233 |
|
| 234 |
<h2>2.0 List Of Requirements</h2> |
| 235 |
|
| 236 |
<dl> |
| 237 |
|
| 238 |
</dl> |
| 239 |
<p align="center"><small><i>This page was last updated on 2025-06-12 09:10:23Z </small></i></p> |
| 240 |
|