Debian Codegraph @

www/c3ref/update_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>Data Change 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_update_hook -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Data Change Notification Callbacks</h2>
122 </div>
123 <blockquote><pre>
124 void *sqlite3_update_hook(
125 sqlite3*,
126 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
127 void*
128 );
129 </pre></blockquote>
130 <p>
131 The sqlite3_update_hook() interface registers a callback function
132 with the <a href="../c3ref/sqlite3.html">database connection</a> identified by the first argument
133 to be invoked whenever a row is updated, inserted or deleted in
134 a <a href="../rowidtable.html">rowid table</a>.
135 Any callback set by a previous call to this function
136 for the same database connection is overridden.</p>
137
138 <p>The second argument is a pointer to the function to invoke when a
139 row is updated, inserted or deleted in a rowid table.
140 The update hook is disabled by invoking sqlite3_update_hook()
141 with a NULL pointer as the second parameter.
142 The first argument to the callback is a copy of the third argument
143 to sqlite3_update_hook().
144 The second callback argument is one of <a href="../c3ref/c_alter_table.html">SQLITE_INSERT</a>, <a href="../c3ref/c_alter_table.html">SQLITE_DELETE</a>,
145 or <a href="../c3ref/c_alter_table.html">SQLITE_UPDATE</a>, depending on the operation that caused the callback
146 to be invoked.
147 The third and fourth arguments to the callback contain pointers to the
148 database and table name containing the affected row.
149 The final callback parameter is the <a href="../lang_createtable.html#rowid">rowid</a> of the row.
150 In the case of an update, this is the <a href="../lang_createtable.html#rowid">rowid</a> after the update takes place.</p>
151
152 <p>The update hook is not invoked when internal system tables are
153 modified (i.e. sqlite_sequence).
154 The update hook is not invoked when <a href="../withoutrowid.html">WITHOUT ROWID</a> tables are modified.</p>
155
156 <p>In the current implementation, the update hook
157 is not invoked when conflicting rows are deleted because of an
158 <a href="../lang_conflict.html">ON CONFLICT REPLACE</a> clause. Nor is the update hook
159 invoked when rows are deleted using the <a href="../lang_delete.html#truncateopt">truncate optimization</a>.
160 The exceptions defined in this paragraph might change in a future
161 release of SQLite.</p>
162
163 <p>Whether the update hook is invoked before or after the
164 corresponding change is currently unspecified and may differ
165 depending on the type of change. Do not rely on the order of the
166 hook call with regards to the final result of the operation which
167 triggers the hook.</p>
168
169 <p>The update hook implementation must not do anything that will modify
170 the database connection that invoked the update hook. Any actions
171 to modify the database connection must be deferred until after the
172 completion of the <a href="../c3ref/step.html">sqlite3_step()</a> call that triggered the update hook.
173 Note that <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a> and <a href="../c3ref/step.html">sqlite3_step()</a> both modify their
174 database connections for the meaning of "modify" in this paragraph.</p>
175
176 <p>The sqlite3_update_hook(D,C,P) function
177 returns the P argument from the previous call
178 on the same <a href="../c3ref/sqlite3.html">database connection</a> D, or NULL for
179 the first call on D.</p>
180
181 <p>See also the <a href="../c3ref/commit_hook.html">sqlite3_commit_hook()</a>, <a href="../c3ref/commit_hook.html">sqlite3_rollback_hook()</a>,
182 and <a href="../c3ref/preupdate_blobwrite.html">sqlite3_preupdate_hook()</a> interfaces.
183 </p><p>See also lists of
184 <a href="../c3ref/objlist.html">Objects</a>,
185 <a href="../c3ref/constlist.html">Constants</a>, and
186 <a href="../c3ref/funclist.html">Functions</a>.</p>
187