Debian Codegraph @

www/c3ref/keyword_check.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>SQL Keyword Checking</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_keyword_check sqlite3_keyword_count sqlite3_keyword_name -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>SQL Keyword Checking</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_keyword_count(void);
125 int sqlite3_keyword_name(int,const char**,int*);
126 int sqlite3_keyword_check(const char*,int);
127 </pre></blockquote>
128 <p>
129 These routines provide access to the set of SQL language keywords
130 recognized by SQLite. Applications can use these routines to determine
131 whether or not a specific identifier needs to be escaped (for example,
132 by enclosing in double-quotes) so as not to confuse the parser.</p>
133
134 <p>The sqlite3_keyword_count() interface returns the number of distinct
135 keywords understood by SQLite.</p>
136
137 <p>The sqlite3_keyword_name(N,Z,L) interface finds the 0-based N-th keyword and
138 makes *Z point to that keyword expressed as UTF8 and writes the number
139 of bytes in the keyword into *L. The string that *Z points to is not
140 zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
141 SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z
142 or L are NULL or invalid pointers then calls to
143 sqlite3_keyword_name(N,Z,L) result in undefined behavior.</p>
144
145 <p>The sqlite3_keyword_check(Z,L) interface checks to see whether or not
146 the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero
147 if it is and zero if not.</p>
148
149 <p>The parser used by SQLite is forgiving. It is often possible to use
150 a keyword as an identifier as long as such use does not result in a
151 parsing ambiguity. For example, the statement
152 "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and
153 creates a new table named "BEGIN" with three columns named
154 "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid
155 using keywords as identifiers. Common techniques used to avoid keyword
156 name collisions include:
157 <ul>
158 <li> Put all identifier names inside double-quotes. This is the official
159 SQL way to escape identifier names.
160 <li> Put identifier names inside &#91;...&#93;. This is not standard SQL,
161 but it is what SQL Server does and so lots of programmers use this
162 technique.
163 <li> Begin every identifier with the letter "Z" as no SQL keywords start
164 with "Z".
165 <li> Include a digit somewhere in every identifier name.
166 </ul></p>
167
168 <p>Note that the number of keywords understood by SQLite can depend on
169 compile-time options. For example, "VACUUM" is not a keyword if
170 SQLite is compiled with the <a href="../compile.html#omit_vacuum">-DSQLITE_OMIT_VACUUM</a> option. Also,
171 new keywords may be added to future releases of SQLite.
172 </p><p>See also lists of
173 <a href="../c3ref/objlist.html">Objects</a>,
174 <a href="../c3ref/constlist.html">Constants</a>, and
175 <a href="../c3ref/funclist.html">Functions</a>.</p>
176