144 lines
5.4 KiB
HTML
144 lines
5.4 KiB
HTML
<!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>Serialize 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;
|
|
}
|
|
</script>
|
|
</div>
|
|
<!-- keywords: sqlite3_serialize -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Serialize a database</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
unsigned char *sqlite3_serialize(
|
|
sqlite3 *db, /* The database connection */
|
|
const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */
|
|
sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */
|
|
unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
|
|
);
|
|
</pre></blockquote>
|
|
<p>
|
|
The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory
|
|
that is a serialization of the S database on <a href="../c3ref/sqlite3.html">database connection</a> D.
|
|
If P is not a NULL pointer, then the size of the database in bytes
|
|
is written into *P.</p>
|
|
|
|
<p>For an ordinary on-disk database file, the serialization is just a
|
|
copy of the disk file. For an in-memory database or a "TEMP" database,
|
|
the serialization is the same sequence of bytes which would be written
|
|
to disk if that database where backed up to disk.</p>
|
|
|
|
<p>The usual case is that sqlite3_serialize() copies the serialization of
|
|
the database into memory obtained from <a href="../c3ref/free.html">sqlite3_malloc64()</a> and returns
|
|
a pointer to that memory. The caller is responsible for freeing the
|
|
returned value to avoid a memory leak. However, if the F argument
|
|
contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
|
|
are made, and the sqlite3_serialize() function will return a pointer
|
|
to the contiguous memory representation of the database that SQLite
|
|
is currently using for that database, or NULL if the no such contiguous
|
|
memory representation of the database exists. A contiguous memory
|
|
representation of the database will usually only exist if there has
|
|
been a prior call to <a href="../c3ref/deserialize.html">sqlite3_deserialize(D,S,...)</a> with the same
|
|
values of D and S.
|
|
The size of the database is written into *P even if the
|
|
SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
|
|
of the database exists.</p>
|
|
|
|
<p>A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
|
|
SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
|
|
allocation error occurs.</p>
|
|
|
|
<p>This interface is only available if SQLite is compiled with the
|
|
<a href="../compile.html#enable_deserialize">SQLITE_ENABLE_DESERIALIZE</a> option.
|
|
</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>
|