Debian Codegraph @

www/c3ref/c_index_constraint_eq.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 Constraint Operator Codes</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_INDEX_CONSTRAINT_EQ SQLITE_INDEX_CONSTRAINT_FUNCTION SQLITE_INDEX_CONSTRAINT_GE SQLITE_INDEX_CONSTRAINT_GLOB SQLITE_INDEX_CONSTRAINT_GT SQLITE_INDEX_CONSTRAINT_IS SQLITE_INDEX_CONSTRAINT_ISNOT SQLITE_INDEX_CONSTRAINT_ISNOTNULL SQLITE_INDEX_CONSTRAINT_ISNULL SQLITE_INDEX_CONSTRAINT_LE SQLITE_INDEX_CONSTRAINT_LIKE SQLITE_INDEX_CONSTRAINT_LIMIT SQLITE_INDEX_CONSTRAINT_LT SQLITE_INDEX_CONSTRAINT_MATCH SQLITE_INDEX_CONSTRAINT_NE SQLITE_INDEX_CONSTRAINT_OFFSET SQLITE_INDEX_CONSTRAINT_REGEXP -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Virtual Table Constraint Operator Codes</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_INDEX_CONSTRAINT_EQ 2
125 #define SQLITE_INDEX_CONSTRAINT_GT 4
126 #define SQLITE_INDEX_CONSTRAINT_LE 8
127 #define SQLITE_INDEX_CONSTRAINT_LT 16
128 #define SQLITE_INDEX_CONSTRAINT_GE 32
129 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
130 #define SQLITE_INDEX_CONSTRAINT_LIKE 65
131 #define SQLITE_INDEX_CONSTRAINT_GLOB 66
132 #define SQLITE_INDEX_CONSTRAINT_REGEXP 67
133 #define SQLITE_INDEX_CONSTRAINT_NE 68
134 #define SQLITE_INDEX_CONSTRAINT_ISNOT 69
135 #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70
136 #define SQLITE_INDEX_CONSTRAINT_ISNULL 71
137 #define SQLITE_INDEX_CONSTRAINT_IS 72
138 #define SQLITE_INDEX_CONSTRAINT_LIMIT 73
139 #define SQLITE_INDEX_CONSTRAINT_OFFSET 74
140 #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150
141 </pre></blockquote>
142 <p>
143 These macros define the allowed values for the
144 <a href="../c3ref/index_info.html">sqlite3_index_info</a>.aConstraint[].op field. Each value represents
145 an operator that is part of a constraint term in the WHERE clause of
146 a query that uses a <a href="../vtab.html">virtual table</a>.</p>
147
148 <p>The left-hand operand of the operator is given by the corresponding
149 aConstraint[].iColumn field. An iColumn of -1 indicates the left-hand
150 operand is the rowid.
151 The SQLITE_INDEX_CONSTRAINT_LIMIT and SQLITE_INDEX_CONSTRAINT_OFFSET
152 operators have no left-hand operand, and so for those operators the
153 corresponding aConstraint[].iColumn is meaningless and should not be
154 used.</p>
155
156 <p>All operator values from SQLITE_INDEX_CONSTRAINT_FUNCTION through
157 value 255 are reserved to represent functions that are overloaded
158 by the <a href="../vtab.html#xfindfunction">xFindFunction method</a> of the virtual table
159 implementation.</p>
160
161 <p>The right-hand operands for each constraint might be accessible using
162 the <a href="../c3ref/vtab_rhs_value.html">sqlite3_vtab_rhs_value()</a> interface. Usually the right-hand
163 operand is only available if it appears as a single constant literal
164 in the input SQL. If the right-hand operand is another column or an
165 expression (even a constant expression) or a parameter, then the
166 sqlite3_vtab_rhs_value() probably will not be able to extract it.
167 The SQLITE_INDEX_CONSTRAINT_ISNULL and
168 SQLITE_INDEX_CONSTRAINT_ISNOTNULL operators have no right-hand operand
169 and hence calls to sqlite3_vtab_rhs_value() for those operators will
170 always return SQLITE_NOTFOUND.</p>
171
172 <p>The collating sequence to be used for comparison can be found using
173 the <a href="../c3ref/vtab_collation.html">sqlite3_vtab_collation()</a> interface. For most real-world virtual
174 tables, the collating sequence of constraints does not matter (for example
175 because the constraints are numeric) and so the sqlite3_vtab_collation()
176 interface is not commonly needed.
177 </p><p>See also lists of
178 <a href="../c3ref/objlist.html">Objects</a>,
179 <a href="../c3ref/constlist.html">Constants</a>, and
180 <a href="../c3ref/funclist.html">Functions</a>.</p>
181