Debian Codegraph @

www/c3ref/stmt_readonly.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 An SQL Statement Writes The Database</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_stmt_readonly -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Determine If An SQL Statement Writes The Database</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
125 </pre></blockquote>
126 <p>
127 The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
128 and only if the <a href="../c3ref/stmt.html">prepared statement</a> X makes no direct changes to
129 the content of the database file.</p>
130
131 <p>Note that <a href="../appfunc.html">application-defined SQL functions</a> or
132 <a href="../vtab.html">virtual tables</a> might change the database indirectly as a side effect.
133 For example, if an application defines a function "eval()" that
134 calls <a href="../c3ref/exec.html">sqlite3_exec()</a>, then the following SQL statement would
135 change the database file through side-effects:</p>
136
137 <p><blockquote><pre>
138 SELECT eval('DELETE FROM t1') FROM t2;
139 </pre></blockquote></p>
140
141 <p>But because the <a href="../lang_select.html">SELECT</a> statement does not change the database file
142 directly, sqlite3_stmt_readonly() would still return true.</p>
143
144 <p>Transaction control statements such as <a href="../lang_transaction.html">BEGIN</a>, <a href="../lang_transaction.html">COMMIT</a>, <a href="../lang_transaction.html">ROLLBACK</a>,
145 <a href="../lang_savepoint.html">SAVEPOINT</a>, and <a href="../lang_savepoint.html">RELEASE</a> cause sqlite3_stmt_readonly() to return true,
146 since the statements themselves do not actually modify the database but
147 rather they control the timing of when other statements modify the
148 database. The <a href="../lang_attach.html">ATTACH</a> and <a href="../lang_detach.html">DETACH</a> statements also cause
149 sqlite3_stmt_readonly() to return true since, while those statements
150 change the configuration of a database connection, they do not make
151 changes to the content of the database files on disk.
152 The sqlite3_stmt_readonly() interface returns true for <a href="../lang_transaction.html">BEGIN</a> since
153 <a href="../lang_transaction.html">BEGIN</a> merely sets internal flags, but the <a href="../lang_transaction.html">BEGIN IMMEDIATE</a> and
154 <a href="../lang_transaction.html">BEGIN EXCLUSIVE</a> commands do touch the database and so
155 sqlite3_stmt_readonly() returns false for those commands.</p>
156
157 <p>This routine returns false if there is any possibility that the
158 statement might change the database file. A false return does
159 not guarantee that the statement will change the database file.
160 For example, an UPDATE statement might have a WHERE clause that
161 makes it a no-op, but the sqlite3_stmt_readonly() result would still
162 be false. Similarly, a CREATE TABLE IF NOT EXISTS statement is a
163 read-only no-op if the table already exists, but
164 sqlite3_stmt_readonly() still returns false for such a statement.</p>
165
166 <p>If prepared statement X is an <a href="../lang_explain.html">EXPLAIN</a> or <a href="../eqp.html">EXPLAIN QUERY PLAN</a>
167 statement, then sqlite3_stmt_readonly(X) returns the same value as
168 if the EXPLAIN or EXPLAIN QUERY PLAN prefix were omitted.
169 </p><p>See also lists of
170 <a href="../c3ref/objlist.html">Objects</a>,
171 <a href="../c3ref/constlist.html">Constants</a>, and
172 <a href="../c3ref/funclist.html">Functions</a>.</p>
173