Debian Codegraph @

www/session/sqlite3changeset_start.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>Create An Iterator To Traverse A Changeset </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 <a href="../session/intro.html"><h2>Session Module C Interface</h2></a><h2>Create An Iterator To Traverse A Changeset </h2><blockquote><pre>int sqlite3changeset_start(
119 sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
120 int nChangeset, /* Size of changeset blob in bytes */
121 void *pChangeset /* Pointer to blob containing changeset */
122 );
123 int sqlite3changeset_start_v2(
124 sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
125 int nChangeset, /* Size of changeset blob in bytes */
126 void *pChangeset, /* Pointer to blob containing changeset */
127 int flags /* SESSION_CHANGESETSTART_* flags */
128 );
129 </pre></blockquote><p>
130 Create an iterator used to iterate through the contents of a changeset.
131 If successful, *pp is set to point to the iterator handle and SQLITE_OK
132 is returned. Otherwise, if an error occurs, *pp is set to zero and an
133 SQLite error code is returned.</p>
134
135 <p>The following functions can be used to advance and query a changeset
136 iterator created by this function:</p>
137
138 <p><ul>
139 <li> <a href="../session/sqlite3changeset_next.html">sqlite3changeset_next()</a>
140 <li> <a href="../session/sqlite3changeset_op.html">sqlite3changeset_op()</a>
141 <li> <a href="../session/sqlite3changeset_new.html">sqlite3changeset_new()</a>
142 <li> <a href="../session/sqlite3changeset_old.html">sqlite3changeset_old()</a>
143 </ul></p>
144
145 <p>It is the responsibility of the caller to eventually destroy the iterator
146 by passing it to <a href="../session/sqlite3changeset_finalize.html">sqlite3changeset_finalize()</a>. The buffer containing the
147 changeset (pChangeset) must remain valid until after the iterator is
148 destroyed.</p>
149
150 <p>Assuming the changeset blob was created by one of the
151 <a href="../session/sqlite3session_changeset.html">sqlite3session_changeset()</a>, <a href="../session/sqlite3changeset_concat.html">sqlite3changeset_concat()</a> or
152 <a href="../session/sqlite3changeset_invert.html">sqlite3changeset_invert()</a> functions, all changes within the changeset
153 that apply to a single table are grouped together. This means that when
154 an application iterates through a changeset using an iterator created by
155 this function, all changes that relate to a single table are visited
156 consecutively. There is no chance that the iterator will visit a change
157 the applies to table X, then one for table Y, and then later on visit
158 another change for table X.</p>
159
160 <p>The behavior of sqlite3changeset_start_v2() and its streaming equivalent
161 may be modified by passing a combination of
162 <a href="../session/c_changesetstart_invert.html">supported flags</a> as the 4th parameter.</p>
163
164 <p>Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>
165 and therefore subject to change.
166 </p><p>See also lists of
167 <a href="../session/objlist.html">Objects</a>,
168 <a href="../session/constlist.html">Constants</a>, and
169 <a href="../session/funclist.html">Functions</a>.</p>
170