Debian Codegraph @

www/c3ref/c_vtab_constraint_support.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>Virtual Table Configuration Options</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: SQLITE_VTAB_CONSTRAINT_SUPPORT SQLITE_VTAB_DIRECTONLY SQLITE_VTAB_INNOCUOUS SQLITE_VTAB_USES_ALL_SCHEMAS {virtual table configuration option} {virtual table configuration options} -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Virtual Table Configuration Options</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
125 #define SQLITE_VTAB_INNOCUOUS 2
126 #define SQLITE_VTAB_DIRECTONLY 3
127 #define SQLITE_VTAB_USES_ALL_SCHEMAS 4
128 </pre></blockquote>
129 <p>
130 These macros define the various options to the
131 <a href="../c3ref/vtab_config.html">sqlite3_vtab_config()</a> interface that <a href="../vtab.html">virtual table</a> implementations
132 can use to customize and optimize their behavior.</p>
133
134 <p><dl>
135 <a name="sqlitevtabconstraintsupport"></a>
136
137 <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt>
138 <dd>Calls of the form
139 <a href="../c3ref/vtab_config.html">sqlite3_vtab_config</a>(db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
140 where X is an integer. If X is zero, then the <a href="../vtab.html">virtual table</a> whose
141 <a href="../vtab.html#xcreate">xCreate</a> or <a href="../vtab.html#xconnect">xConnect</a> method invoked <a href="../c3ref/vtab_config.html">sqlite3_vtab_config()</a> does not
142 support constraints. In this configuration (which is the default) if
143 a call to the <a href="../vtab.html#xupdate">xUpdate</a> method returns <a href="../rescode.html#constraint">SQLITE_CONSTRAINT</a>, then the entire
144 statement is rolled back as if <a href="../lang_conflict.html">OR ABORT</a> had been
145 specified as part of the user's SQL statement, regardless of the actual
146 ON CONFLICT mode specified.</p>
147
148 <p>If X is non-zero, then the virtual table implementation guarantees
149 that if <a href="../vtab.html#xupdate">xUpdate</a> returns <a href="../rescode.html#constraint">SQLITE_CONSTRAINT</a>, it will do so before
150 any modifications to internal or persistent data structures have been made.
151 If the <a href="../lang_conflict.html">ON CONFLICT</a> mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
152 is able to roll back a statement or database transaction, and abandon
153 or continue processing the current SQL statement as appropriate.
154 If the ON CONFLICT mode is REPLACE and the <a href="../vtab.html#xupdate">xUpdate</a> method returns
155 <a href="../rescode.html#constraint">SQLITE_CONSTRAINT</a>, SQLite handles this as if the ON CONFLICT mode
156 had been ABORT.</p>
157
158 <p>Virtual table implementations that are required to handle OR REPLACE
159 must do so within the <a href="../vtab.html#xupdate">xUpdate</a> method. If a call to the
160 <a href="../c3ref/vtab_on_conflict.html">sqlite3_vtab_on_conflict()</a> function indicates that the current ON
161 CONFLICT policy is REPLACE, the virtual table implementation should
162 silently replace the appropriate rows within the xUpdate callback and
163 return SQLITE_OK. Or, if this is not possible, it may return
164 SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
165 constraint handling.
166 </dd></p>
167
168 <p><a name="sqlitevtabdirectonly"></a>
169 <dt>SQLITE_VTAB_DIRECTONLY</dt>
170 <dd>Calls of the form
171 <a href="../c3ref/vtab_config.html">sqlite3_vtab_config</a>(db,SQLITE_VTAB_DIRECTONLY) from within the
172 the <a href="../vtab.html#xconnect">xConnect</a> or <a href="../vtab.html#xcreate">xCreate</a> methods of a <a href="../vtab.html">virtual table</a> implementation
173 prohibits that virtual table from being used from within triggers and
174 views.
175 </dd></p>
176
177 <p><a name="sqlitevtabinnocuous"></a>
178 <dt>SQLITE_VTAB_INNOCUOUS</dt>
179 <dd>Calls of the form
180 <a href="../c3ref/vtab_config.html">sqlite3_vtab_config</a>(db,SQLITE_VTAB_INNOCUOUS) from within the
181 <a href="../vtab.html#xconnect">xConnect</a> or <a href="../vtab.html#xcreate">xCreate</a> methods of a <a href="../vtab.html">virtual table</a> implementation
182 identify that virtual table as being safe to use from within triggers
183 and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the
184 virtual table can do no serious harm even if it is controlled by a
185 malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS
186 flag unless absolutely necessary.
187 </dd></p>
188
189 <p><a name="sqlitevtabusesallschemas"></a>
190 <dt>SQLITE_VTAB_USES_ALL_SCHEMAS</dt>
191 <dd>Calls of the form
192 <a href="../c3ref/vtab_config.html">sqlite3_vtab_config</a>(db,SQLITE_VTAB_USES_ALL_SCHEMA) from within the
193 the <a href="../vtab.html#xconnect">xConnect</a> or <a href="../vtab.html#xcreate">xCreate</a> methods of a <a href="../vtab.html">virtual table</a> implementation
194 instruct the query planner to begin at least a read transaction on
195 all schemas ("main", "temp", and any ATTACH-ed databases) whenever the
196 virtual table is used.
197 </dd>
198 </dl>
199 </p><p>See also lists of
200 <a href="../c3ref/objlist.html">Objects</a>,
201 <a href="../c3ref/constlist.html">Constants</a>, and
202 <a href="../c3ref/funclist.html">Functions</a>.</p>
203