Debian Codegraph @

www/session/sqlite3changegroup_change_finish.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>Finish adding one-at-at-time changes 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>Finish adding one-at-at-time changes to a changegroup</h2><blockquote><pre>int sqlite3changegroup_change_finish(
119 sqlite3_changegroup*,
120 int bDiscard,
121 char **pzErr
122 );
123 </pre></blockquote><p>
124 This function may only be called following a successful call to
125 sqlite3changegroup_change_begin(). Otherwise, it is an SQLITE_MISUSE error.</p>
126
127 <p>If parameter bDiscard is non-zero, then the current change is simply
128 discarded. In this case this function is always successful and SQLITE_OK
129 returned.</p>
130
131 <p>If parameter bDiscard is zero, then an attempt is made to add the current
132 change to the changegroup. Assuming the changegroup is configured to
133 produce a changeset (not a patchset), this requires that:</p>
134
135 <p> * If the change is an INSERT or DELETE, then a value must be specified
136 for all columns of the new.* or old.* record, respectively.</p>
137
138 <p> * If the change is an UPDATE record, then values must be provided for
139 the PRIMARY KEY columns of the old.* record, but must not be provided
140 for PRIMARY KEY columns of the new.* record.</p>
141
142 <p> * If the change is an UPDATE record, then for each non-PRIMARY KEY
143 column in the old.* record for which a value has been provided, a
144 value must also be provided for the same column in the new.* record.
145 Similarly, for each non-PK column in the old.* record for which
146 a value is not provided, a value must not be provided for the same
147 column in the new.* record.</p>
148
149 <p> * All values specified for PRIMARY KEY columns must be non-NULL.</p>
150
151 <p>Otherwise, it is an error. </p>
152
153 <p>If the changegroup already contains a change for the same row (identified
154 by PRIMARY KEY columns), then the current change is combined with the
155 existing change in the same way as for sqlite3changegroup_add().</p>
156
157 <p>For a patchset, all of the above rules apply except that it doesn't matter
158 whether or not values are provided for the non-PK old.* record columns
159 for an UPDATE or DELETE change. This means that code used to produce
160 a changeset using the sqlite3changegroup_change_xxx() APIs may also
161 be used to produce patchsets.</p>
162
163 <p>If the call is successful, SQLITE_OK is returned. Otherwise, if an error
164 occurs, an SQLite error code is returned. If an error is returned and
165 parameter pzErr is not NULL, then (*pzErr) may be set to point to a buffer
166 containing a nul-terminated, utf-8 encoded, English language error message.
167 It is the responsibility of the caller to eventually free any such error
168 message buffer using sqlite3_free().
169 </p><p>See also lists of
170 <a href="../session/objlist.html">Objects</a>,
171 <a href="../session/constlist.html">Constants</a>, and
172 <a href="../session/funclist.html">Functions</a>.</p>
173