1 files changed, 177 insertions, 0 deletions
diff --git a/www/c3ref/deserialize.html b/www/c3ref/deserialize.html
new file mode 100644
index 0000000..6e3afdc
--- /dev/null
+++ b/www/c3ref/deserialize.html
@@ -0,0 +1,177 @@
+<!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>Deserialize a database</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_deserialize -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Deserialize a database</h2>
+</div>
+<blockquote><pre>
+int sqlite3_deserialize(
+  sqlite3 *db,            /* The database connection */
+  const char *zSchema,    /* Which DB to reopen with the deserialization */
+  unsigned char *pData,   /* The serialized database content */
+  sqlite3_int64 szDb,     /* Number bytes in the deserialization */
+  sqlite3_int64 szBuf,    /* Total size of buffer pData[] */
+  unsigned mFlags         /* Zero or more SQLITE_DESERIALIZE_* flags */
+);
+</pre></blockquote>
+<p>
+The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
+<a href="../c3ref/sqlite3.html">database connection</a> D to disconnect from database S and then
+reopen S as an in-memory database based on the serialization contained
+in P.  The serialized database P is N bytes in size.  M is the size of
+the buffer P, which might be larger than N.  If M is larger than N, and
+the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is
+permitted to add content to the in-memory database as long as the total
+size does not exceed M bytes.</p>
+
+<p>If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
+invoke sqlite3_free() on the serialization buffer when the database
+connection closes.  If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then
+SQLite will try to increase the buffer size using sqlite3_realloc64()
+if writes on the database cause it to grow larger than M bytes.</p>
+
+<p>Applications must not modify the buffer P or invalidate it before
+the database connection D is closed.</p>
+
+<p>The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the
+database is currently in a read transaction or is involved in a backup
+operation.</p>
+
+<p>It is not possible to deserialized into the TEMP database.  If the
+S argument to sqlite3_deserialize(D,S,P,N,M,F) is "temp" then the
+function returns SQLITE_ERROR.</p>
+
+<p>The deserialized database should not be in <a href="../wal.html">WAL mode</a>.  If the database
+is in WAL mode, then any attempt to use the database file will result
+in an <a href="../rescode.html#cantopen">SQLITE_CANTOPEN</a> error.  The application can set the
+<a href="../fileformat2.html#vnums">file format version numbers</a> (bytes 18 and 19) of the input database P
+to 0x01 prior to invoking sqlite3_deserialize(D,S,P,N,M,F) to force the
+database file into rollback mode and work around this limitation.</p>
+
+<p>If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the
+SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
+<a href="../c3ref/free.html">sqlite3_free()</a> is invoked on argument P prior to returning.</p>
+
+<p>This interface is omitted if SQLite is compiled with the
+<a href="../compile.html#omit_deserialize">SQLITE_OMIT_DESERIALIZE</a> option.
+</p><p>See also lists of
+  <a href="../c3ref/objlist.html">Objects</a>,
+  <a href="../c3ref/constlist.html">Constants</a>, and
+  <a href="../c3ref/funclist.html">Functions</a>.</p>
+