156 lines
6.1 KiB
HTML
156 lines
6.1 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>Attach A Table To A Session Object</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>Attach A Table To A Session Object</h2><blockquote><pre>int sqlite3session_attach(
|
|
sqlite3_session *pSession, /* Session object */
|
|
const char *zTab /* Table name */
|
|
);
|
|
</pre></blockquote><p>
|
|
If argument zTab is not NULL, then it is the name of a table to attach
|
|
to the session object passed as the first argument. All subsequent changes
|
|
made to the table while the session object is enabled will be recorded. See
|
|
documentation for <a href="../session/sqlite3session_changeset.html">sqlite3session_changeset()</a> for further details.</p>
|
|
|
|
<p>Or, if argument zTab is NULL, then changes are recorded for all tables
|
|
in the database. If additional tables are added to the database (by
|
|
executing "CREATE TABLE" statements) after this call is made, changes for
|
|
the new tables are also recorded.</p>
|
|
|
|
<p>Changes can only be recorded for tables that have a PRIMARY KEY explicitly
|
|
defined as part of their CREATE TABLE statement. It does not matter if the
|
|
PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
|
|
KEY may consist of a single column, or may be a composite key.</p>
|
|
|
|
<p>It is not an error if the named table does not exist in the database. Nor
|
|
is it an error if the named table does not have a PRIMARY KEY. However,
|
|
no changes will be recorded in either of these scenarios.</p>
|
|
|
|
<p>Changes are not recorded for individual rows that have NULL values stored
|
|
in one or more of their PRIMARY KEY columns.</p>
|
|
|
|
<p>SQLITE_OK is returned if the call completes without error. Or, if an error
|
|
occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.</p>
|
|
|
|
<p><h3>Special sqlite_stat1 Handling</h3></p>
|
|
|
|
<p>As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to
|
|
some of the rules above. In SQLite, the schema of sqlite_stat1 is:
|
|
<pre>
|
|
CREATE TABLE sqlite_stat1(tbl,idx,stat)
|
|
</pre></p>
|
|
|
|
<p>Even though sqlite_stat1 does not have a PRIMARY KEY, changes are
|
|
recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes
|
|
are recorded for rows for which (idx IS NULL) is true. However, for such
|
|
rows a zero-length blob (SQL value X'') is stored in the changeset or
|
|
patchset instead of a NULL value. This allows such changesets to be
|
|
manipulated by legacy implementations of sqlite3changeset_invert(),
|
|
concat() and similar.</p>
|
|
|
|
<p>The sqlite3changeset_apply() function automatically converts the
|
|
zero-length blob back to a NULL value when updating the sqlite_stat1
|
|
table. However, if the application calls sqlite3changeset_new(),
|
|
sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
|
|
iterator directly (including on a changeset iterator passed to a
|
|
conflict-handler callback) then the X'' value is returned. The application
|
|
must translate X'' to NULL itself if required.</p>
|
|
|
|
<p>Legacy (older than 3.22.0) versions of the sessions module cannot capture
|
|
changes made to the sqlite_stat1 table. Legacy versions of the
|
|
sqlite3changeset_apply() function silently ignore any modifications to the
|
|
sqlite_stat1 table that are part of a changeset or patchset.
|
|
</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>
|