| 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 Base85() SQL Function</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 Base85() SQL Function |
| 122 |
</div> |
| 123 |
</div> |
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
<h1 id="overview"><span>1. </span>Overview</h1> |
| 130 |
|
| 131 |
<p> The base85() function is an SQL function implemented as |
| 132 |
a <a href="loadext.html">loadable extension</a> for SQLite. The function converts a binary |
| 133 |
BLOB into an equivalent base-85 text encoding |
| 134 |
or converts that same base-85 text encoding back into a BLOB. |
| 135 |
|
| 136 |
</p><p> The base85() function is not a standard part of SQLite. |
| 137 |
It must be loaded as a separate extension. The source code to |
| 138 |
base85() is in the |
| 139 |
<a href="https://sqlite.org/src/file/ext/misc/base85.c">base85.c source file</a> |
| 140 |
in the <a href="https://sqlite.org/src/file/ext/misc">ext/misc/ folder</a> of the |
| 141 |
SQLite source tree. |
| 142 |
|
| 143 |
</p><p> The base85() function is not included in standard builds of |
| 144 |
the SQLite library, but it is loaded by default in the <a href="cli.html">CLI</a>. This |
| 145 |
is typical of the <a href="cli.html">CLI</a> which loads various extensions above and beyond |
| 146 |
what are available in the standard SQLite library. |
| 147 |
|
| 148 |
</p><p> |
| 149 |
Like <a href="base64.html">base64()</a> representations, the base85() function can be used |
| 150 |
to format binary content through any |
| 151 |
sane ASCII channel unmolested. It also plays nicely in CSV or |
| 152 |
written as TCL brace-enclosed literals or SQL string literals. |
| 153 |
It is not suited for unmodified use in XML-like documents. |
| 154 |
|
| 155 |
|
| 156 |
</p><h1 id="encoding"><span>2. </span>Encoding</h1> |
| 157 |
|
| 158 |
<p> |
| 159 |
The encoding used resembles Ascii85, but was devised by the author |
| 160 |
(Larry Brasfield) before Mozilla, Adobe, ZMODEM or other Ascii85 |
| 161 |
variant sources existed, in the 1984 timeframe on a VAX mainframe. |
| 162 |
Further, this is an independent implementation of a base85 system. |
| 163 |
Hence, the author has rightfully put this into the public domain. |
| 164 |
|
| 165 |
</p><p> |
| 166 |
Base85 numerals are taken from the set of 7-bit USASCII codes, |
| 167 |
excluding control characters and Space ! " ' ( ) { | } ~ Del |
| 168 |
in code order representing digit values 0 to 84 (base 10.) |
| 169 |
|
| 170 |
</p><p> |
| 171 |
Groups of 4 bytes, interpreted as big-endian 32-bit values, |
| 172 |
are represented as 5-digit base85 numbers with MS to LS digit |
| 173 |
order. Groups of 1-3 bytes are represented with 2-4 digits, |
| 174 |
still big-endian but 8-24 bit values. (Using big-endian yields |
| 175 |
the simplest transition to byte groups smaller than 4 bytes. |
| 176 |
These byte groups can also be considered base-256 numbers.) |
| 177 |
Groups of 0 bytes are represented with 0 digits and vice-versa. |
| 178 |
No pad characters are used; encoded base85 numeral sequence |
| 179 |
(aka "group") length maps 1-to-1 to the decoded binary length. |
| 180 |
|
| 181 |
</p><p> |
| 182 |
Any character not in the base85 numeral set delimits groups. |
| 183 |
When base85 is streamed or stored in containers of indefinite |
| 184 |
size, newline is used to separate it into sub-sequences of no |
| 185 |
more than 80 digits so that fgets() can be used to read it. |
| 186 |
|
| 187 |
</p><h1 id="features"><span>3. </span>Features</h1> |
| 188 |
|
| 189 |
<ol> |
| 190 |
<li><p> |
| 191 |
The base85() function always takes a single argument that must be TEXT |
| 192 |
(for base85-to-binary conversion) or a BLOB (for binary-to-base85 conversion). |
| 193 |
|
| 194 |
</p></li><li><p> |
| 195 |
If the argument to base85() is a BLOB, then the return value is TEXT |
| 196 |
according to the encoding described above. |
| 197 |
|
| 198 |
</p></li><li><p> |
| 199 |
If the argument to base85() is TEXT as described above then the return value is |
| 200 |
a BLOB that is the binary data corresponding to that base85 text. |
| 201 |
|
| 202 |
</p></li><li><p> |
| 203 |
An error is raised if the argument to base85() is something other than |
| 204 |
TEXT or BLOB. |
| 205 |
</p></li></ol> |
| 206 |
|
| 207 |
<h1 id="see_also"><span>4. </span>See Also</h1> |
| 208 |
|
| 209 |
<ul> |
| 210 |
<li><p>Build-in SQL function <a href="lang_corefunc.html#hex">hex()</a>. |
| 211 |
</p></li><li><p>Extension function <a href="base64.html">base64()</a>. |
| 212 |
</p></li></ul> |
| 213 |
<p align="center"><small><i>This page was last updated on 2025-07-12 15:11:36Z </small></i></p> |
| 214 |
|