146 lines
5.8 KiB
HTML
146 lines
5.8 KiB
HTML
<!DOCTYPE html>
|
|
<html><head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<link href="../sqlite.css" rel="stylesheet">
|
|
<title>Create An Iterator To Traverse A Changeset </title>
|
|
<!-- path=../ -->
|
|
</head>
|
|
<body>
|
|
<div class=nosearch>
|
|
<a href="../index.html">
|
|
<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
|
|
</a>
|
|
<div><!-- IE hack to prevent disappearing logo --></div>
|
|
<div class="tagline desktoponly">
|
|
Small. Fast. Reliable.<br>Choose any three.
|
|
</div>
|
|
<div class="menu mainmenu">
|
|
<ul>
|
|
<li><a href="../index.html">Home</a>
|
|
<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
|
|
<li class='wideonly'><a href='../about.html'>About</a>
|
|
<li class='desktoponly'><a href="../docs.html">Documentation</a>
|
|
<li class='desktoponly'><a href="../download.html">Download</a>
|
|
<li class='wideonly'><a href='../copyright.html'>License</a>
|
|
<li class='desktoponly'><a href="../support.html">Support</a>
|
|
<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
|
|
<li class='search' id='search_menubutton'>
|
|
<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
|
|
</ul>
|
|
</div>
|
|
<div class="menu submenu" id="submenu">
|
|
<ul>
|
|
<li><a href='../about.html'>About</a>
|
|
<li><a href='../docs.html'>Documentation</a>
|
|
<li><a href='../download.html'>Download</a>
|
|
<li><a href='../support.html'>Support</a>
|
|
<li><a href='../prosupport.html'>Purchase</a>
|
|
</ul>
|
|
</div>
|
|
<div class="searchmenu" id="searchmenu">
|
|
<form method="GET" action="../search">
|
|
<select name="s" id="searchtype">
|
|
<option value="d">Search Documentation</option>
|
|
<option value="c">Search Changelog</option>
|
|
</select>
|
|
<input type="text" name="q" id="searchbox" value="">
|
|
<input type="submit" value="Go">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>
|
|
function toggle_div(nm) {
|
|
var w = document.getElementById(nm);
|
|
if( w.style.display=="block" ){
|
|
w.style.display = "none";
|
|
}else{
|
|
w.style.display = "block";
|
|
}
|
|
}
|
|
function toggle_search() {
|
|
var w = document.getElementById("searchmenu");
|
|
if( w.style.display=="block" ){
|
|
w.style.display = "none";
|
|
} else {
|
|
w.style.display = "block";
|
|
setTimeout(function(){
|
|
document.getElementById("searchbox").focus()
|
|
}, 30);
|
|
}
|
|
}
|
|
function div_off(nm){document.getElementById(nm).style.display="none";}
|
|
window.onbeforeunload = function(e){div_off("submenu");}
|
|
/* Disable the Search feature if we are not operating from CGI, since */
|
|
/* Search is accomplished using CGI and will not work without it. */
|
|
if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
|
|
document.getElementById("search_menubutton").style.display = "none";
|
|
}
|
|
/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
|
|
function hideorshow(btn,obj){
|
|
var x = document.getElementById(obj);
|
|
var b = document.getElementById(btn);
|
|
if( x.style.display!='none' ){
|
|
x.style.display = 'none';
|
|
b.innerHTML='show';
|
|
}else{
|
|
x.style.display = '';
|
|
b.innerHTML='hide';
|
|
}
|
|
return false;
|
|
}
|
|
</script>
|
|
</div>
|
|
<a href="intro.html"><h2>Session Module C Interface</h2></a><h2>Create An Iterator To Traverse A Changeset </h2><blockquote><pre>int sqlite3changeset_start(
|
|
sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
|
|
int nChangeset, /* Size of changeset blob in bytes */
|
|
void *pChangeset /* Pointer to blob containing changeset */
|
|
);
|
|
int sqlite3changeset_start_v2(
|
|
sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
|
|
int nChangeset, /* Size of changeset blob in bytes */
|
|
void *pChangeset, /* Pointer to blob containing changeset */
|
|
int flags /* SESSION_CHANGESETSTART_* flags */
|
|
);
|
|
</pre></blockquote><p>
|
|
Create an iterator used to iterate through the contents of a changeset.
|
|
If successful, *pp is set to point to the iterator handle and SQLITE_OK
|
|
is returned. Otherwise, if an error occurs, *pp is set to zero and an
|
|
SQLite error code is returned.</p>
|
|
|
|
<p>The following functions can be used to advance and query a changeset
|
|
iterator created by this function:</p>
|
|
|
|
<p><ul>
|
|
<li> <a href="../session/sqlite3changeset_next.html">sqlite3changeset_next()</a>
|
|
<li> <a href="../session/sqlite3changeset_op.html">sqlite3changeset_op()</a>
|
|
<li> <a href="../session/sqlite3changeset_new.html">sqlite3changeset_new()</a>
|
|
<li> <a href="../session/sqlite3changeset_old.html">sqlite3changeset_old()</a>
|
|
</ul></p>
|
|
|
|
<p>It is the responsibility of the caller to eventually destroy the iterator
|
|
by passing it to <a href="../session/sqlite3changeset_finalize.html">sqlite3changeset_finalize()</a>. The buffer containing the
|
|
changeset (pChangeset) must remain valid until after the iterator is
|
|
destroyed.</p>
|
|
|
|
<p>Assuming the changeset blob was created by one of the
|
|
<a href="../session/sqlite3session_changeset.html">sqlite3session_changeset()</a>, <a href="../session/sqlite3changeset_concat.html">sqlite3changeset_concat()</a> or
|
|
<a href="../session/sqlite3changeset_invert.html">sqlite3changeset_invert()</a> functions, all changes within the changeset
|
|
that apply to a single table are grouped together. This means that when
|
|
an application iterates through a changeset using an iterator created by
|
|
this function, all changes that relate to a single table are visited
|
|
consecutively. There is no chance that the iterator will visit a change
|
|
the applies to table X, then one for table Y, and then later on visit
|
|
another change for table X.</p>
|
|
|
|
<p>The behavior of sqlite3changeset_start_v2() and its streaming equivalent
|
|
may be modified by passing a combination of
|
|
<a href="../session/c_changesetstart_invert.html">supported flags</a> as the 4th parameter.</p>
|
|
|
|
<p>Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>
|
|
and therefore subject to change.
|
|
</p><p>See also lists of
|
|
<a href="objlist.html">Objects</a>,
|
|
<a href="constlist.html">Constants</a>, and
|
|
<a href="funclist.html">Functions</a>.</p>
|