Debian Codegraph @

www/session/sqlite3session_diff.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>Load The Difference Between Tables Into A Session</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>Load The Difference Between Tables Into A Session</h2><blockquote><pre>int sqlite3session_diff(
119 sqlite3_session *pSession,
120 const char *zFromDb,
121 const char *zTbl,
122 char **pzErrMsg
123 );
124 </pre></blockquote><p>
125 If it is not already attached to the session object passed as the first
126 argument, this function attaches table zTbl in the same manner as the
127 <a href="../session/sqlite3session_attach.html">sqlite3session_attach()</a> function. If zTbl does not exist, or if it
128 does not have a primary key, this function is a no-op (but does not return
129 an error).</p>
130
131 <p>Argument zFromDb must be the name of a database ("main", "temp" etc.)
132 attached to the same database handle as the session object that contains
133 a table compatible with the table attached to the session by this function.
134 A table is considered compatible if it:</p>
135
136 <p><ul>
137 <li> Has the same name,
138 <li> Has the same set of columns declared in the same order, and
139 <li> Has the same PRIMARY KEY definition.
140 </ul></p>
141
142 <p>If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
143 are compatible but do not have any PRIMARY KEY columns, it is not an error
144 but no changes are added to the session object. As with other session
145 APIs, tables without PRIMARY KEYs are simply ignored.</p>
146
147 <p>This function adds a set of changes to the session object that could be
148 used to update the table in database zFrom (call this the "from-table")
149 so that its content is the same as the table attached to the session
150 object (call this the "to-table"). Specifically:</p>
151
152 <p><ul>
153 <li> For each row (primary key) that exists in the to-table but not in
154 the from-table, an INSERT record is added to the session object.</p>
155
156 <p> <li> For each row (primary key) that exists in the to-table but not in
157 the from-table, a DELETE record is added to the session object.</p>
158
159 <p> <li> For each row (primary key) that exists in both tables, but features
160 different non-PK values in each, an UPDATE record is added to the
161 session.
162 </ul></p>
163
164 <p>To clarify, if this function is called and then a changeset constructed
165 using <a href="../session/sqlite3session_changeset.html">sqlite3session_changeset()</a>, then after applying that changeset to
166 database zFrom the contents of the two compatible tables would be
167 identical.</p>
168
169 <p>Unless the call to this function is a no-op as described above, it is an
170 error if database zFrom does not exist or does not contain the required
171 compatible table.</p>
172
173 <p>If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
174 error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
175 may be set to point to a buffer containing an English language error
176 message. It is the responsibility of the caller to free this buffer using
177 sqlite3_free().
178 </p><p>See also lists of
179 <a href="../session/objlist.html">Objects</a>,
180 <a href="../session/constlist.html">Constants</a>, and
181 <a href="../session/funclist.html">Functions</a>.</p>
182