Debian Codegraph @

www/c3ref/serialize.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>Serialize a database</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 <!-- keywords: sqlite3_serialize -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Serialize a database</h2>
122 </div>
123 <blockquote><pre>
124 unsigned char *sqlite3_serialize(
125 sqlite3 *db, /* The database connection */
126 const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */
127 sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */
128 unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
129 );
130 </pre></blockquote>
131 <p>
132 The sqlite3_serialize(D,S,P,F) interface returns a pointer to
133 memory that is a serialization of the S database on
134 <a href="../c3ref/sqlite3.html">database connection</a> D. If S is a NULL pointer, the main database is used.
135 If P is not a NULL pointer, then the size of the database in bytes
136 is written into *P.</p>
137
138 <p>For an ordinary on-disk database file, the serialization is just a
139 copy of the disk file. For an in-memory database or a "TEMP" database,
140 the serialization is the same sequence of bytes which would be written
141 to disk if that database were backed up to disk.</p>
142
143 <p>The usual case is that sqlite3_serialize() copies the serialization of
144 the database into memory obtained from <a href="../c3ref/free.html">sqlite3_malloc64()</a> and returns
145 a pointer to that memory. The caller is responsible for freeing the
146 returned value to avoid a memory leak. However, if the F argument
147 contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
148 are made, and the sqlite3_serialize() function will return a pointer
149 to the contiguous memory representation of the database that SQLite
150 is currently using for that database, or NULL if no such contiguous
151 memory representation of the database exists. A contiguous memory
152 representation of the database will usually only exist if there has
153 been a prior call to <a href="../c3ref/deserialize.html">sqlite3_deserialize(D,S,...)</a> with the same
154 values of D and S.
155 The size of the database is written into *P even if the
156 SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
157 of the database exists.</p>
158
159 <p>After the call, if the SQLITE_SERIALIZE_NOCOPY bit had been set,
160 the returned buffer content will remain accessible and unchanged
161 until either the next write operation on the connection or when
162 the connection is closed, and applications must not modify the
163 buffer. If the bit had been clear, the returned buffer will not
164 be accessed by SQLite after the call.</p>
165
166 <p>A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
167 SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
168 allocation error occurs.</p>
169
170 <p>This interface is omitted if SQLite is compiled with the
171 <a href="../compile.html#omit_deserialize">SQLITE_OMIT_DESERIALIZE</a> option.
172 </p><p>See also lists of
173 <a href="../c3ref/objlist.html">Objects</a>,
174 <a href="../c3ref/constlist.html">Constants</a>, and
175 <a href="../c3ref/funclist.html">Functions</a>.</p>
176