154 lines
5.7 KiB
HTML
154 lines
5.7 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>Virtual Table 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>
|
||
|
|
<!-- keywords: sqlite3_module {virtual table module} -->
|
||
|
|
<div class=nosearch>
|
||
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
||
|
|
<h2>Virtual Table Object</h2>
|
||
|
|
</div>
|
||
|
|
<blockquote><pre>
|
||
|
|
struct sqlite3_module {
|
||
|
|
int iVersion;
|
||
|
|
int (*xCreate)(sqlite3*, void *pAux,
|
||
|
|
int argc, const char *const*argv,
|
||
|
|
sqlite3_vtab **ppVTab, char**);
|
||
|
|
int (*xConnect)(sqlite3*, void *pAux,
|
||
|
|
int argc, const char *const*argv,
|
||
|
|
sqlite3_vtab **ppVTab, char**);
|
||
|
|
int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
|
||
|
|
int (*xDisconnect)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xDestroy)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
|
||
|
|
int (*xClose)(sqlite3_vtab_cursor*);
|
||
|
|
int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
|
||
|
|
int argc, sqlite3_value **argv);
|
||
|
|
int (*xNext)(sqlite3_vtab_cursor*);
|
||
|
|
int (*xEof)(sqlite3_vtab_cursor*);
|
||
|
|
int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
|
||
|
|
int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
|
||
|
|
int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
|
||
|
|
int (*xBegin)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xSync)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xCommit)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xRollback)(sqlite3_vtab *pVTab);
|
||
|
|
int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
|
||
|
|
void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
|
||
|
|
void **ppArg);
|
||
|
|
int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
|
||
|
|
/* The methods above are in version 1 of the sqlite_module object. Those
|
||
|
|
** below are for version 2 and greater. */
|
||
|
|
int (*xSavepoint)(sqlite3_vtab *pVTab, int);
|
||
|
|
int (*xRelease)(sqlite3_vtab *pVTab, int);
|
||
|
|
int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
|
||
|
|
/* The methods above are in versions 1 and 2 of the sqlite_module object.
|
||
|
|
** Those below are for version 3 and greater. */
|
||
|
|
int (*xShadowName)(const char*);
|
||
|
|
};
|
||
|
|
</pre></blockquote>
|
||
|
|
<p>
|
||
|
|
This structure, sometimes called a "virtual table module",
|
||
|
|
defines the implementation of a <a href="../vtab.html">virtual table</a>.
|
||
|
|
This structure consists mostly of methods for the module.</p>
|
||
|
|
|
||
|
|
<p>A virtual table module is created by filling in a persistent
|
||
|
|
instance of this structure and passing a pointer to that instance
|
||
|
|
to <a href="../c3ref/create_module.html">sqlite3_create_module()</a> or <a href="../c3ref/create_module.html">sqlite3_create_module_v2()</a>.
|
||
|
|
The registration remains valid until it is replaced by a different
|
||
|
|
module or until the <a href="../c3ref/sqlite3.html">database connection</a> closes. The content
|
||
|
|
of this structure must not change while it is registered with
|
||
|
|
any database connection.
|
||
|
|
</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>
|