Debian Codegraph @

www/c3ref/snapshot_get.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>Record A Database Snapshot</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_snapshot_get -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Record A Database Snapshot</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_snapshot_get(
125 sqlite3 *db,
126 const char *zSchema,
127 sqlite3_snapshot **ppSnapshot
128 );
129 </pre></blockquote>
130 <p>
131 The <a href="../c3ref/snapshot_get.html">sqlite3_snapshot_get(D,S,P)</a> interface attempts to make a
132 new <a href="../c3ref/snapshot.html">sqlite3_snapshot</a> object that records the current state of
133 schema S in database connection D. On success, the
134 <a href="../c3ref/snapshot_get.html">sqlite3_snapshot_get(D,S,P)</a> interface writes a pointer to the newly
135 created <a href="../c3ref/snapshot.html">sqlite3_snapshot</a> object into *P and returns SQLITE_OK.
136 If there is not already a read-transaction open on schema S when
137 this function is called, one is opened automatically.</p>
138
139 <p>If a read-transaction is opened by this function, then it is guaranteed
140 that the returned snapshot object may not be invalidated by a database
141 writer or checkpointer until after the read-transaction is closed. This
142 is not guaranteed if a read-transaction is already open when this
143 function is called. In that case, any subsequent write or checkpoint
144 operation on the database may invalidate the returned snapshot handle,
145 even while the read-transaction remains open.</p>
146
147 <p>The following must be true for this function to succeed. If any of
148 the following statements are false when sqlite3_snapshot_get() is
149 called, SQLITE_ERROR is returned. The final value of *P is undefined
150 in this case.</p>
151
152 <p><ul>
153 <li> The database handle must not be in <a href="../c3ref/get_autocommit.html">autocommit mode</a>.</p>
154
155 <p><li> Schema S of <a href="../c3ref/sqlite3.html">database connection</a> D must be a <a href="../wal.html">WAL mode</a> database.</p>
156
157 <p><li> There must not be a write transaction open on schema S of database
158 connection D.</p>
159
160 <p><li> One or more transactions must have been written to the current wal
161 file since it was created on disk (by any connection). This means
162 that a snapshot cannot be taken on a wal mode database with no wal
163 file immediately after it is first opened. At least one transaction
164 must be written to it first.
165 </ul></p>
166
167 <p>This function may also return SQLITE_NOMEM. If it is called with the
168 database handle in autocommit mode but fails for some other reason,
169 whether or not a read transaction is opened on schema S is undefined.</p>
170
171 <p>The <a href="../c3ref/snapshot.html">sqlite3_snapshot</a> object returned from a successful call to
172 <a href="../c3ref/snapshot_get.html">sqlite3_snapshot_get()</a> must be freed using <a href="../c3ref/snapshot_free.html">sqlite3_snapshot_free()</a>
173 to avoid a memory leak.</p>
174
175 <p>The <a href="../c3ref/snapshot_get.html">sqlite3_snapshot_get()</a> interface is only available when the
176 <a href="../compile.html#enable_snapshot">SQLITE_ENABLE_SNAPSHOT</a> compile-time option is used.
177 </p><p>See also lists of
178 <a href="../c3ref/objlist.html">Objects</a>,
179 <a href="../c3ref/constlist.html">Constants</a>, and
180 <a href="../c3ref/funclist.html">Functions</a>.</p>
181