Debian Codegraph @

www/c3ref/vtab_distinct.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>Determine if a virtual table query is DISTINCT</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_distinct -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Determine if a virtual table query is DISTINCT</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_vtab_distinct(sqlite3_index_info*);
125 </pre></blockquote>
126 <p>
127 This API may only be used from within an <a href="../vtab.html#xbestindex">xBestIndex method</a>
128 of a <a href="../vtab.html">virtual table</a> implementation. The result of calling this
129 interface from outside of xBestIndex() is undefined and probably harmful.</p>
130
131 <p>The sqlite3_vtab_distinct() interface returns an integer between 0 and
132 3. The integer returned by sqlite3_vtab_distinct()
133 gives the virtual table additional information about how the query
134 planner wants the output to be ordered. As long as the virtual table
135 can meet the ordering requirements of the query planner, it may set
136 the "orderByConsumed" flag.</p>
137
138 <p><ol><li value="0"><p>
139 If the sqlite3_vtab_distinct() interface returns 0, that means
140 that the query planner needs the virtual table to return all rows in the
141 sort order defined by the "nOrderBy" and "aOrderBy" fields of the
142 <a href="../c3ref/index_info.html">sqlite3_index_info</a> object. This is the default expectation. If the
143 virtual table outputs all rows in sorted order, then it is always safe for
144 the xBestIndex method to set the "orderByConsumed" flag, regardless of
145 the return value from sqlite3_vtab_distinct().
146 <li value="1"><p>
147 If the sqlite3_vtab_distinct() interface returns 1, that means
148 that the query planner does not need the rows to be returned in sorted order
149 as long as all rows with the same values in all columns identified by the
150 "aOrderBy" field are adjacent. This mode is used when the query planner
151 is doing a GROUP BY.
152 <li value="2"><p>
153 If the sqlite3_vtab_distinct() interface returns 2, that means
154 that the query planner does not need the rows returned in any particular
155 order, as long as rows with the same values in all columns identified
156 by "aOrderBy" are adjacent. Furthermore, when two or more rows
157 contain the same values for all columns identified by "colUsed", all but
158 one such row may optionally be omitted from the result.
159 The virtual table is not required to omit rows that are duplicates
160 over the "colUsed" columns, but if the virtual table can do that without
161 too much extra effort, it could potentially help the query to run faster.
162 This mode is used for a DISTINCT query.
163 <li value="3"><p>
164 If the sqlite3_vtab_distinct() interface returns 3, that means the
165 virtual table must return rows in the order defined by "aOrderBy" as
166 if the sqlite3_vtab_distinct() interface had returned 0. However if
167 two or more rows in the result have the same values for all columns
168 identified by "colUsed", then all but one such row may optionally be
169 omitted. Like when the return value is 2, the virtual table
170 is not required to omit rows that are duplicates over the "colUsed"
171 columns, but if the virtual table can do that without
172 too much extra effort, it could potentially help the query to run faster.
173 This mode is used for queries
174 that have both DISTINCT and ORDER BY clauses.
175 </ol></p>
176
177 <p><p>The following table summarizes the conditions under which the
178 virtual table is allowed to set the "orderByConsumed" flag based on
179 the value returned by sqlite3_vtab_distinct(). This table is a
180 restatement of the previous four paragraphs:</p>
181
182 <p><table border=1 cellspacing=0 cellpadding=10 width="90%">
183 <tr>
184 <td valign="top">sqlite3_vtab_distinct() return value
185 <td valign="top">Rows are returned in aOrderBy order
186 <td valign="top">Rows with the same value in all aOrderBy columns are
187 adjacent
188 <td valign="top">Duplicates over all colUsed columns may be omitted
189 <tr><td>0<td>yes<td>yes<td>no
190 <tr><td>1<td>no<td>yes<td>no
191 <tr><td>2<td>no<td>yes<td>yes
192 <tr><td>3<td>yes<td>yes<td>yes
193 </table></p>
194
195 <p>For the purposes of comparing virtual table output values to see if the
196 values are the same value for sorting purposes, two NULL values are
197 considered to be the same. In other words, the comparison operator is "IS"
198 (or "IS NOT DISTINCT FROM") and not "==".</p>
199
200 <p>If a virtual table implementation is unable to meet the requirements
201 specified above, then it must not set the "orderByConsumed" flag in the
202 <a href="../c3ref/index_info.html">sqlite3_index_info</a> object or an incorrect answer may result.</p>
203
204 <p>A virtual table implementation is always free to return rows in any order
205 it wants, as long as the "orderByConsumed" flag is not set. When the
206 "orderByConsumed" flag is unset, the query planner will add extra
207 <a href="../opcode.html">bytecode</a> to ensure that the final results returned by the SQL query are
208 ordered correctly. The use of the "orderByConsumed" flag and the
209 sqlite3_vtab_distinct() interface is merely an optimization. Careful
210 use of the sqlite3_vtab_distinct() interface and the "orderByConsumed"
211 flag might help queries against a virtual table to run faster. Being
212 overly aggressive and setting the "orderByConsumed" flag when it is not
213 valid to do so, on the other hand, might cause SQLite to return incorrect
214 results.
215 </p><p>See also lists of
216 <a href="../c3ref/objlist.html">Objects</a>,
217 <a href="../c3ref/constlist.html">Constants</a>, and
218 <a href="../c3ref/funclist.html">Functions</a>.</p>
219