150 lines
6.0 KiB
HTML
150 lines
6.0 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>Commit And Rollback Notification Callbacks</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>
|
|
<!-- keywords: sqlite3_commit_hook sqlite3_rollback_hook -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Commit And Rollback Notification Callbacks</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
|
|
void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
|
|
</pre></blockquote>
|
|
<p>
|
|
The sqlite3_commit_hook() interface registers a callback
|
|
function to be invoked whenever a transaction is <a href="../lang_transaction.html">committed</a>.
|
|
Any callback set by a previous call to sqlite3_commit_hook()
|
|
for the same database connection is overridden.
|
|
The sqlite3_rollback_hook() interface registers a callback
|
|
function to be invoked whenever a transaction is <a href="../lang_transaction.html">rolled back</a>.
|
|
Any callback set by a previous call to sqlite3_rollback_hook()
|
|
for the same database connection is overridden.
|
|
The pArg argument is passed through to the callback.
|
|
If the callback on a commit hook function returns non-zero,
|
|
then the commit is converted into a rollback.</p>
|
|
|
|
<p>The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
|
|
return the P argument from the previous call of the same function
|
|
on the same <a href="../c3ref/sqlite3.html">database connection</a> D, or NULL for
|
|
the first call for each function on D.</p>
|
|
|
|
<p>The commit and rollback hook callbacks are not reentrant.
|
|
The callback implementation must not do anything that will modify
|
|
the database connection that invoked the callback. Any actions
|
|
to modify the database connection must be deferred until after the
|
|
completion of the <a href="../c3ref/step.html">sqlite3_step()</a> call that triggered the commit
|
|
or rollback hook in the first place.
|
|
Note that running any other SQL statements, including SELECT statements,
|
|
or merely calling <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a> and <a href="../c3ref/step.html">sqlite3_step()</a> will modify
|
|
the database connections for the meaning of "modify" in this paragraph.</p>
|
|
|
|
<p>Registering a NULL function disables the callback.</p>
|
|
|
|
<p>When the commit hook callback routine returns zero, the <a href="../lang_transaction.html">COMMIT</a>
|
|
operation is allowed to continue normally. If the commit hook
|
|
returns non-zero, then the <a href="../lang_transaction.html">COMMIT</a> is converted into a <a href="../lang_transaction.html">ROLLBACK</a>.
|
|
The rollback hook is invoked on a rollback that results from a commit
|
|
hook returning non-zero, just as it would be with any other rollback.</p>
|
|
|
|
<p>For the purposes of this API, a transaction is said to have been
|
|
rolled back if an explicit "ROLLBACK" statement is executed, or
|
|
an error or constraint causes an implicit rollback to occur.
|
|
The rollback callback is not invoked if a transaction is
|
|
automatically rolled back because the database connection is closed.</p>
|
|
|
|
<p>See also the <a href="../c3ref/update_hook.html">sqlite3_update_hook()</a> interface.
|
|
</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>
|