Debian Codegraph @

www/session/sqlite3changegroup_add.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>Add A Changeset To A Changegroup</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>Add A Changeset To A Changegroup</h2><blockquote><pre>int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
119 </pre></blockquote><p>
120 Add all changes within the changeset (or patchset) in buffer pData (size
121 nData bytes) to the changegroup. </p>
122
123 <p>If the buffer contains a patchset, then all prior calls to this function
124 on the same changegroup object must also have specified patchsets. Or, if
125 the buffer contains a changeset, so must have the earlier calls to this
126 function. Otherwise, SQLITE_ERROR is returned and no changes are added
127 to the changegroup.</p>
128
129 <p>Rows within the changeset and changegroup are identified by the values in
130 their PRIMARY KEY columns. A change in the changeset is considered to
131 apply to the same row as a change already present in the changegroup if
132 the two rows have the same primary key.</p>
133
134 <p>Changes to rows that do not already appear in the changegroup are
135 simply copied into it. Or, if both the new changeset and the changegroup
136 contain changes that apply to a single row, the final contents of the
137 changegroup depends on the type of each change, as follows:</p>
138
139 <p><table border=1 style="margin-left:8ex;margin-right:8ex">
140 <tr><th style="white-space:pre">Existing Change </th>
141 <th style="white-space:pre">New Change </th>
142 <th>Output Change
143 <tr><td>INSERT <td>INSERT <td>
144 The new change is ignored. This case does not occur if the new
145 changeset was recorded immediately after the changesets already
146 added to the changegroup.
147 <tr><td>INSERT <td>UPDATE <td>
148 The INSERT change remains in the changegroup. The values in the
149 INSERT change are modified as if the row was inserted by the
150 existing change and then updated according to the new change.
151 <tr><td>INSERT <td>DELETE <td>
152 The existing INSERT is removed from the changegroup. The DELETE is
153 not added.
154 <tr><td>UPDATE <td>INSERT <td>
155 The new change is ignored. This case does not occur if the new
156 changeset was recorded immediately after the changesets already
157 added to the changegroup.
158 <tr><td>UPDATE <td>UPDATE <td>
159 The existing UPDATE remains within the changegroup. It is amended
160 so that the accompanying values are as if the row was updated once
161 by the existing change and then again by the new change.
162 <tr><td>UPDATE <td>DELETE <td>
163 The existing UPDATE is replaced by the new DELETE within the
164 changegroup.
165 <tr><td>DELETE <td>INSERT <td>
166 If one or more of the column values in the row inserted by the
167 new change differ from those in the row deleted by the existing
168 change, the existing DELETE is replaced by an UPDATE within the
169 changegroup. Otherwise, if the inserted row is exactly the same
170 as the deleted row, the existing DELETE is simply discarded.
171 <tr><td>DELETE <td>UPDATE <td>
172 The new change is ignored. This case does not occur if the new
173 changeset was recorded immediately after the changesets already
174 added to the changegroup.
175 <tr><td>DELETE <td>DELETE <td>
176 The new change is ignored. This case does not occur if the new
177 changeset was recorded immediately after the changesets already
178 added to the changegroup.
179 </table></p>
180
181 <p>If the new changeset contains changes to a table that is already present
182 in the changegroup, then the number of columns and the position of the
183 primary key columns for the table must be consistent. If this is not the
184 case, this function fails with SQLITE_SCHEMA. Except, if the changegroup
185 object has been configured with a database schema using the
186 sqlite3changegroup_schema() API, then it is possible to combine changesets
187 with different numbers of columns for a single table, provided that
188 they are otherwise compatible.</p>
189
190 <p>If the input changeset appears to be corrupt and the corruption is
191 detected, SQLITE_CORRUPT is returned. Or, if an out-of-memory condition
192 occurs during processing, this function returns SQLITE_NOMEM. </p>
193
194 <p>In all cases, if an error occurs the state of the final contents of the
195 changegroup is undefined. If no error occurs, SQLITE_OK is returned.
196 </p><p>See also lists of
197 <a href="../session/objlist.html">Objects</a>,
198 <a href="../session/constlist.html">Constants</a>, and
199 <a href="../session/funclist.html">Functions</a>.</p>
200