Debian Codegraph @

www/c3ref/c_prepare_dont_log.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>Prepare Flags</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_PREPARE_DONT_LOG SQLITE_PREPARE_FROM_DDL SQLITE_PREPARE_NORMALIZE SQLITE_PREPARE_NO_VTAB SQLITE_PREPARE_PERSISTENT -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Prepare Flags</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_PREPARE_PERSISTENT 0x01
125 #define SQLITE_PREPARE_NORMALIZE 0x02
126 #define SQLITE_PREPARE_NO_VTAB 0x04
127 #define SQLITE_PREPARE_DONT_LOG 0x10
128 #define SQLITE_PREPARE_FROM_DDL 0x20
129 </pre></blockquote>
130 <p>
131 These constants define various flags that can be passed into the
132 "prepFlags" parameter of the <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a> and
133 <a href="../c3ref/prepare.html">sqlite3_prepare16_v3()</a> interfaces.</p>
134
135 <p>New flags may be added in future releases of SQLite.</p>
136
137 <p><dl>
138 <a name="sqlitepreparepersistent"></a>
139 <dt>SQLITE_PREPARE_PERSISTENT</dt>
140 <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
141 that the prepared statement will be retained for a long time and
142 probably reused many times. Without this flag, <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a>
143 and <a href="../c3ref/prepare.html">sqlite3_prepare16_v3()</a> assume that the prepared statement will
144 be used just once or at most a few times and then destroyed using
145 <a href="../c3ref/finalize.html">sqlite3_finalize()</a> relatively soon. The current implementation acts
146 on this hint by avoiding the use of <a href="../malloc.html#lookaside">lookaside memory</a> so as not to
147 deplete the limited store of lookaside memory. Future versions of
148 SQLite may act on this hint differently.</p>
149
150 <p><a name="sqlitepreparenormalize"></a>
151 <dt>SQLITE_PREPARE_NORMALIZE</dt>
152 <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used
153 to be required for any prepared statement that wanted to use the
154 <a href="../c3ref/expanded_sql.html">sqlite3_normalized_sql()</a> interface. However, the
155 <a href="../c3ref/expanded_sql.html">sqlite3_normalized_sql()</a> interface is now available to all
156 prepared statements, regardless of whether or not they use this
157 flag.</p>
158
159 <p><a name="sqlitepreparenovtab"></a>
160 <dt>SQLITE_PREPARE_NO_VTAB</dt>
161 <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
162 to return an error (error code SQLITE_ERROR) if the statement uses
163 any virtual tables.</p>
164
165 <p><a name="sqlitepreparedontlog"></a>
166 <dt>SQLITE_PREPARE_DONT_LOG</dt>
167 <dd>The SQLITE_PREPARE_DONT_LOG flag prevents SQL compiler
168 errors from being sent to the error log defined by
169 <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfiglog">SQLITE_CONFIG_LOG</a>. This can be used, for example, to do test
170 compiles to see if some SQL syntax is well-formed, without generating
171 messages on the global error log when it is not. If the test compile
172 fails, the sqlite3_prepare_v3() call returns the same error indications
173 with or without this flag; it just omits the call to <a href="../c3ref/log.html">sqlite3_log()</a> that
174 logs the error.</p>
175
176 <p><a name="sqlitepreparefromddl"></a>
177 <dt>SQLITE_PREPARE_FROM_DDL</dt>
178 <dd>The SQLITE_PREPARE_FROM_DDL flag causes the SQL compiler to enforce
179 security constraints that would otherwise only be enforced when parsing
180 the database schema. In other words, the SQLITE_PREPARE_FROM_DDL flag
181 causes the SQL compiler to treat the SQL statement being prepared as if
182 it had come from an attacker. When SQLITE_PREPARE_FROM_DDL is used and
183 <a href="../c3ref/c_dbconfig_defensive.html#sqlitedbconfigtrustedschema">SQLITE_DBCONFIG_TRUSTED_SCHEMA</a> is off, SQL functions may only be called
184 if they are tagged with <a href="../c3ref/c_deterministic.html#sqliteinnocuous">SQLITE_INNOCUOUS</a> and virtual tables may only
185 be used if they are tagged with <a href="../c3ref/c_vtab_constraint_support.html#sqlitevtabinnocuous">SQLITE_VTAB_INNOCUOUS</a>. Best practice
186 is to use the SQLITE_PREPARE_FROM_DDL option when preparing any SQL that
187 is derived from parts of the database schema. In particular, virtual
188 table implementations that run SQL statements that are derived from
189 arguments to their CREATE VIRTUAL TABLE statement should always use
190 <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a> and set the SQLITE_PREPARE_FROM_DDL flag to
191 prevent bypass of the <a href="../c3ref/c_dbconfig_defensive.html#sqlitedbconfigtrustedschema">SQLITE_DBCONFIG_TRUSTED_SCHEMA</a> security checks.
192 </dl>
193 </p><p>See also lists of
194 <a href="../c3ref/objlist.html">Objects</a>,
195 <a href="../c3ref/constlist.html">Constants</a>, and
196 <a href="../c3ref/funclist.html">Functions</a>.</p>
197