Debian Codegraph @

www/c3ref/vtab_in.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>Identify and handle IN constraints in xBestIndex</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_vtab_in -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Identify and handle IN constraints in xBestIndex</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle);
125 </pre></blockquote>
126 <p>
127 This interface may only be used from within an
128 <a href="../vtab.html#xbestindex">xBestIndex() method</a> of a <a href="../vtab.html">virtual table</a> implementation.
129 The result of invoking this interface from any other context is
130 undefined and probably harmful.</p>
131
132 <p>A constraint on a virtual table of the form
133 "<a href="../lang_expr.html#in_op">column IN (...)</a>" is
134 communicated to the xBestIndex method as a
135 <a href="../c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_EQ</a> constraint. If xBestIndex wants to use
136 this constraint, it must set the corresponding
137 aConstraintUsage[].argvIndex to a positive integer. Then, under
138 the usual mode of handling IN operators, SQLite generates <a href="../opcode.html">bytecode</a>
139 that invokes the <a href="../vtab.html#xfilter">xFilter() method</a> once for each value
140 on the right-hand side of the IN operator. Thus the virtual table
141 only sees a single value from the right-hand side of the IN operator
142 at a time.</p>
143
144 <p>In some cases, however, it would be advantageous for the virtual
145 table to see all values on the right-hand of the IN operator all at
146 once. The sqlite3_vtab_in() interfaces facilitates this in two ways:</p>
147
148 <p><ol>
149 <li><p>
150 A call to sqlite3_vtab_in(P,N,-1) will return true (non-zero)
151 if and only if the <a href="../c3ref/index_info.html">P->aConstraint</a>[N] constraint
152 is an <a href="../lang_expr.html#in_op">IN operator</a> that can be processed all at once. In other words,
153 sqlite3_vtab_in() with -1 in the third argument is a mechanism
154 by which the virtual table can ask SQLite if all-at-once processing
155 of the IN operator is even possible.</p>
156
157 <p><li><p>
158 A call to sqlite3_vtab_in(P,N,F) with F==1 or F==0 indicates
159 to SQLite that the virtual table does or does not want to process
160 the IN operator all-at-once, respectively. Thus when the third
161 parameter (F) is non-negative, this interface is the mechanism by
162 which the virtual table tells SQLite how it wants to process the
163 IN operator.
164 </ol></p>
165
166 <p>The sqlite3_vtab_in(P,N,F) interface can be invoked multiple times
167 within the same xBestIndex method call. For any given P,N pair,
168 the return value from sqlite3_vtab_in(P,N,F) will always be the same
169 within the same xBestIndex call. If the interface returns true
170 (non-zero), that means that the constraint is an IN operator
171 that can be processed all-at-once. If the constraint is not an IN
172 operator or cannot be processed all-at-once, then the interface returns
173 false.</p>
174
175 <p>All-at-once processing of the IN operator is selected if both of the
176 following conditions are met:</p>
177
178 <p><ol>
179 <li><p> The P->aConstraintUsage[N].argvIndex value is set to a positive
180 integer. This is how the virtual table tells SQLite that it wants to
181 use the N-th constraint.</p>
182
183 <p><li><p> The last call to sqlite3_vtab_in(P,N,F) for which F was
184 non-negative had F>=1.
185 </ol></p>
186
187 <p>If either or both of the conditions above are false, then SQLite uses
188 the traditional one-at-a-time processing strategy for the IN constraint.
189 If both conditions are true, then the argvIndex-th parameter to the
190 xFilter method will be an <a href="../c3ref/value.html">sqlite3_value</a> that appears to be NULL,
191 but which can be passed to <a href="../c3ref/vtab_in_first.html">sqlite3_vtab_in_first()</a> and
192 <a href="../c3ref/vtab_in_first.html">sqlite3_vtab_in_next()</a> to find all values on the right-hand side
193 of the IN constraint.
194 </p><p>See also lists of
195 <a href="../c3ref/objlist.html">Objects</a>,
196 <a href="../c3ref/constlist.html">Constants</a>, and
197 <a href="../c3ref/funclist.html">Functions</a>.</p>
198