Debian Codegraph @

www/completion.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>The COMPLETION() Table-Valued Function</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 <div class=fancy>
119 <div class=nosearch>
120 <div class="fancy_title">
121 The COMPLETION() Table-Valued Function
122 </div>
123 </div>
124
125
126
127
128 <h1 id="overview"><span>1. </span>Overview</h1>
129
130 <p>The COMPLETION extension implements a <a href="vtab.html#tabfunc2">table-valued function</a> named
131 "completion" that can be used to suggest completions of partially entered
132 words during interactive SQL input. The completion table can be
133 used to help implement tab-completion, for example.
134
135 </p><h1 id="details"><span>2. </span>Details</h1>
136
137 <p>The designed query interface is:
138
139 </p><div class="codeblock"><pre>SELECT DISTINCT candidate COLLATE nocase
140 FROM completion($prefix, $wholeline)
141 ORDER BY 1;
142 </pre></div>
143
144 <p>The query above will return suggestions for the whole input word that
145 begins with $prefix. The $wholeline parameter is all text from the beginning
146 of the line up to the insertion point. The $wholeline parameter is used
147 for context.
148
149 </p><p>The $prefix parameter may be NULL, in which case the prefix is deduced
150 from $wholeline. Or, the $wholeline parameter may be NULL or omitted if
151 context information is unavailable or if context-aware completion is not
152 desired.
153
154 </p><p>The completion table might return the same candidate more than once, and
155 it will return candidates in an arbitrary order. The DISTINCT keyword and
156 the ORDER BY in the sample query above are added to make the answers unique
157 and in lexicographical order.
158
159 </p><h2 id="example_usage"><span>2.1. </span>Example Usage</h2>
160
161 <p>The completion table is used to implement tab-completion in the
162 <a href="cli.html">command-line shell</a> in conjunction with either the readline or linenoise
163 input line editing packages for unix. See the
164 <a href="https://sqlite.org/src/file/src/shell.c.in">https://sqlite.org/src/file/src/shell.c.in</a> source file for example
165 code. Search for "FROM completion" to find the relevant code sections.
166
167 </p><p>Because the completion table is built into the command-line shell in order
168 to provide for tab-completions, you can run test queries against the
169 completion table directly in the command-line shell. Simply type a
170 query such as the example shown above, filling in appropriate values
171 for $prefix and $wholeline, and observe the output.
172
173 </p><h1 id="limitations"><span>3. </span>Limitations</h1>
174
175 <p>The completion table is designed for interactive use. It will return
176 answers at a speed appropriate for human typing. No effort is made to
177 be unusually efficient, so long as the response time is nearly instantaneous
178 in a user interface.
179
180 </p><p>As of this writing (2017-07-13), the completion virtual table only
181 looks for SQL keywords, and schema, table, and column names. The
182 context contained in $wholeline is completely ignored. Future enhancements
183 will try to return new completions taken from function and pragma names
184 and other sources, as well as consider more context. The completion
185 table should be considered a work-in-progress.
186 </p><p align="center"><small><i>This page was last updated on 2022-01-08 05:02:57Z </small></i></p>
187