Debian Codegraph @

www/base64.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 Base64() 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 Base64() SQL Function
122 </div>
123 </div>
124
125
126
127
128
129 <h1 id="overview"><span>1. </span>Overview</h1>
130
131 <p> The base64() 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 equivalent <a href="https://datatracker.ietf.org/doc/html/rfc4648">RFC 4648</a>
134 text or converts RFC 4648 text into the equivalent BLOB.
135
136 </p><p> The base64() function is not a standard part of SQLite.
137 It must be loaded as a separate extension. The source code to
138 base64() is in the
139 <a href="https://sqlite.org/src/file/ext/misc/base64.c">base64.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 base64() 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><h1 id="features"><span>2. </span>Features</h1>
149
150 <ol>
151 <li><p>
152 The base64() function always takes a single argument.
153
154 </p></li><li><p>
155 If the argument to base64() is a BLOB, then the return value is TEXT
156 that is the <a href="https://datatracker.ietf.org/doc/html/rfc4648">RFC 4648</a> encoding
157 of that BLOB.
158
159 </p></li><li><p>
160 If the argument to base64() is base64 TEXT then the return value is
161 a BLOB that is the binary data corresponding to that base64 TEXT.
162
163 </p></li><li><p>
164 If the argument to base64() is NULL, then NULL is returned.
165
166 </p></li><li><p>
167 An error is raised if the argument to base64() is something other than
168 TEXT, BLOB, or NULL.
169
170 </p></li><li><p>
171 If the argument is TEXT, leading and trailing whitespace is ignored.
172
173 </p></li><li><p>
174 If the argument is TEXT that has a prefix that looks like base64 but contains
175 non-base64 characters, then as much of the input as possible is translated into
176 a BLOB and that BLOB is returned.
177
178 </p></li><li><p>
179 The base64() function uses the standard
180 <a href="https://datatracker.ietf.org/doc/html/rfc4648">RFC 4648</a> alphabet:
181 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/".
182
183 </p></li></ol>
184
185 <h1 id="see_also"><span>3. </span>See Also</h1>
186
187 <ul>
188 <li><p>Build-in SQL functions <a href="lang_corefunc.html#hex">hex()</a> and <a href="lang_corefunc.html#unhex">unhex()</a>.
189 </p></li><li><p>Extension function <a href="base85.html">base85()</a>.
190 </p></li></ul>
191 <p align="center"><small><i>This page was last updated on 2024-09-20 17:36:26Z </small></i></p>
192