Debian Codegraph @

www/c3ref/commit_hook.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>Commit And Rollback Notification Callbacks</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 <!-- keywords: sqlite3_commit_hook sqlite3_rollback_hook -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Commit And Rollback Notification Callbacks</h2>
122 </div>
123 <blockquote><pre>
124 void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
125 void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
126 </pre></blockquote>
127 <p>
128 The sqlite3_commit_hook() interface registers a callback
129 function to be invoked whenever a transaction is <a href="../lang_transaction.html">committed</a>.
130 Any callback set by a previous call to sqlite3_commit_hook()
131 for the same database connection is overridden.
132 The sqlite3_rollback_hook() interface registers a callback
133 function to be invoked whenever a transaction is <a href="../lang_transaction.html">rolled back</a>.
134 Any callback set by a previous call to sqlite3_rollback_hook()
135 for the same database connection is overridden.
136 The pArg argument is passed through to the callback.
137 If the callback on a commit hook function returns non-zero,
138 then the commit is converted into a rollback.</p>
139
140 <p>The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
141 return the P argument from the previous call of the same function
142 on the same <a href="../c3ref/sqlite3.html">database connection</a> D, or NULL for
143 the first call for each function on D.</p>
144
145 <p>The commit and rollback hook callbacks are not reentrant.
146 The callback implementation must not do anything that will modify
147 the database connection that invoked the callback. Any actions
148 to modify the database connection must be deferred until after the
149 completion of the <a href="../c3ref/step.html">sqlite3_step()</a> call that triggered the commit
150 or rollback hook in the first place.
151 Note that running any other SQL statements, including SELECT statements,
152 or merely calling <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a> and <a href="../c3ref/step.html">sqlite3_step()</a> will modify
153 the database connections for the meaning of "modify" in this paragraph.</p>
154
155 <p>Registering a NULL function disables the callback.</p>
156
157 <p>When the commit hook callback routine returns zero, the <a href="../lang_transaction.html">COMMIT</a>
158 operation is allowed to continue normally. If the commit hook
159 returns non-zero, then the <a href="../lang_transaction.html">COMMIT</a> is converted into a <a href="../lang_transaction.html">ROLLBACK</a>.
160 The rollback hook is invoked on a rollback that results from a commit
161 hook returning non-zero, just as it would be with any other rollback.</p>
162
163 <p>For the purposes of this API, a transaction is said to have been
164 rolled back if an explicit "ROLLBACK" statement is executed, or
165 an error or constraint causes an implicit rollback to occur.
166 The rollback callback is not invoked if a transaction is
167 automatically rolled back because the database connection is closed.</p>
168
169 <p>See also the <a href="../c3ref/update_hook.html">sqlite3_update_hook()</a> interface.
170 </p><p>See also lists of
171 <a href="../c3ref/objlist.html">Objects</a>,
172 <a href="../c3ref/constlist.html">Constants</a>, and
173 <a href="../c3ref/funclist.html">Functions</a>.</p>
174