| 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>Rebasing changesets</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>Rebasing changesets</h2><blockquote><pre>typedef struct sqlite3_rebaser sqlite3_rebaser; |
| 119 |
</pre></blockquote><p><b>Important:</b> This interface is <a href="../c3ref/experimental.html">experimental</a> and is subject to change without notice.</p><p> |
| 120 |
Suppose there is a site hosting a database in state S0. And that |
| 121 |
modifications are made that move that database to state S1 and a |
| 122 |
changeset recorded (the "local" changeset). Then, a changeset based |
| 123 |
on S0 is received from another site (the "remote" changeset) and |
| 124 |
applied to the database. The database is then in state |
| 125 |
(S1+"remote"), where the exact state depends on any conflict |
| 126 |
resolution decisions (OMIT or REPLACE) made while applying "remote". |
| 127 |
Rebasing a changeset is to update it to take those conflict |
| 128 |
resolution decisions into account, so that the same conflicts |
| 129 |
do not have to be resolved elsewhere in the network. </p> |
| 130 |
|
| 131 |
<p>For example, if both the local and remote changesets contain an |
| 132 |
INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":</p> |
| 133 |
|
| 134 |
<p> local: INSERT INTO t1 VALUES(1, 'v1'); |
| 135 |
remote: INSERT INTO t1 VALUES(1, 'v2');</p> |
| 136 |
|
| 137 |
<p>and the conflict resolution is REPLACE, then the INSERT change is |
| 138 |
removed from the local changeset (it was overridden). Or, if the |
| 139 |
conflict resolution was "OMIT", then the local changeset is modified |
| 140 |
to instead contain:</p> |
| 141 |
|
| 142 |
<p> UPDATE t1 SET b = 'v2' WHERE a=1;</p> |
| 143 |
|
| 144 |
<p>Changes within the local changeset are rebased as follows:</p> |
| 145 |
|
| 146 |
<p><dl> |
| 147 |
<dt>Local INSERT<dd> |
| 148 |
This may only conflict with a remote INSERT. If the conflict |
| 149 |
resolution was OMIT, then add an UPDATE change to the rebased |
| 150 |
changeset. Or, if the conflict resolution was REPLACE, add |
| 151 |
nothing to the rebased changeset.</p> |
| 152 |
|
| 153 |
<p><dt>Local DELETE<dd> |
| 154 |
This may conflict with a remote UPDATE or DELETE. In both cases the |
| 155 |
only possible resolution is OMIT. If the remote operation was a |
| 156 |
DELETE, then add no change to the rebased changeset. If the remote |
| 157 |
operation was an UPDATE, then the old.* fields of change are updated |
| 158 |
to reflect the new.* values in the UPDATE.</p> |
| 159 |
|
| 160 |
<p><dt>Local UPDATE<dd> |
| 161 |
This may conflict with a remote UPDATE or DELETE. If it conflicts |
| 162 |
with a DELETE, and the conflict resolution was OMIT, then the update |
| 163 |
is changed into an INSERT. Any undefined values in the new.* record |
| 164 |
from the update change are filled in using the old.* values from |
| 165 |
the conflicting DELETE. Or, if the conflict resolution was REPLACE, |
| 166 |
the UPDATE change is simply omitted from the rebased changeset.</p> |
| 167 |
|
| 168 |
<p> If conflict is with a remote UPDATE and the resolution is OMIT, then |
| 169 |
the old.* values are rebased using the new.* values in the remote |
| 170 |
change. Or, if the resolution is REPLACE, then the change is copied |
| 171 |
into the rebased changeset with updates to columns also updated by |
| 172 |
the conflicting remote UPDATE removed. If this means no columns would |
| 173 |
be updated, the change is omitted. |
| 174 |
</dl></p> |
| 175 |
|
| 176 |
<p>A local change may be rebased against multiple remote changes |
| 177 |
simultaneously. If a single key is modified by multiple remote |
| 178 |
changesets, they are combined as follows before the local changeset |
| 179 |
is rebased:</p> |
| 180 |
|
| 181 |
<p><ul> |
| 182 |
<li> If there has been one or more REPLACE resolutions on a |
| 183 |
key, it is rebased according to a REPLACE.</p> |
| 184 |
|
| 185 |
<p> <li> If there have been no REPLACE resolutions on a key, then |
| 186 |
the local changeset is rebased according to the most recent |
| 187 |
of the OMIT resolutions. |
| 188 |
</ul></p> |
| 189 |
|
| 190 |
<p>Note that conflict resolutions from multiple remote changesets are |
| 191 |
combined on a per-field basis, not per-row. This means that in the |
| 192 |
case of multiple remote UPDATE operations, some fields of a single |
| 193 |
local change may be rebased for REPLACE while others are rebased for |
| 194 |
OMIT.</p> |
| 195 |
|
| 196 |
<p>In order to rebase a local changeset, the remote changeset must first |
| 197 |
be applied to the local database using sqlite3changeset_apply_v2() and |
| 198 |
the buffer of rebase information captured. Then:</p> |
| 199 |
|
| 200 |
<p><ol> |
| 201 |
<li> An sqlite3_rebaser object is created by calling |
| 202 |
sqlite3rebaser_create(). |
| 203 |
<li> The new object is configured with the rebase buffer obtained from |
| 204 |
sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure(). |
| 205 |
If the local changeset is to be rebased against multiple remote |
| 206 |
changesets, then sqlite3rebaser_configure() should be called |
| 207 |
multiple times, in the same order that the multiple |
| 208 |
sqlite3changeset_apply_v2() calls were made. |
| 209 |
<li> Each local changeset is rebased by calling sqlite3rebaser_rebase(). |
| 210 |
<li> The sqlite3_rebaser object is deleted by calling |
| 211 |
sqlite3rebaser_delete(). |
| 212 |
</ol> |
| 213 |
</p><p>See also lists of |
| 214 |
<a href="../session/objlist.html">Objects</a>, |
| 215 |
<a href="../session/constlist.html">Constants</a>, and |
| 216 |
<a href="../session/funclist.html">Functions</a>.</p> |
| 217 |
|