Debian Codegraph @

www/c3ref/expanded_sql.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>Retrieving Statement SQL</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_expanded_sql sqlite3_normalized_sql sqlite3_sql -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Retrieving Statement SQL</h2>
122 </div>
123 <blockquote><pre>
124 const char *sqlite3_sql(sqlite3_stmt *pStmt);
125 char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
126 #ifdef SQLITE_ENABLE_NORMALIZE
127 const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
128 #endif
129 </pre></blockquote>
130 <p>
131 The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
132 SQL text used to create <a href="../c3ref/stmt.html">prepared statement</a> P if P was
133 created by <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a>, <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a>,
134 <a href="../c3ref/prepare.html">sqlite3_prepare16_v2()</a>, or <a href="../c3ref/prepare.html">sqlite3_prepare16_v3()</a>.
135 The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
136 string containing the SQL text of prepared statement P with
137 <a href="../lang_expr.html#varparam">bound parameters</a> expanded.
138 The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
139 string containing the normalized SQL text of prepared statement P. The
140 semantics used to normalize a SQL statement are unspecified and subject
141 to change. At a minimum, literal values will be replaced with suitable
142 placeholders.</p>
143
144 <p>For example, if a prepared statement is created using the SQL
145 text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
146 and parameter :xyz is unbound, then sqlite3_sql() will return
147 the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
148 will return "SELECT 2345,NULL".</p>
149
150 <p>The sqlite3_expanded_sql() interface returns NULL if insufficient memory
151 is available to hold the result, or if the result would exceed the
152 maximum string length determined by the <a href="../c3ref/c_limit_attached.html#sqlitelimitlength">SQLITE_LIMIT_LENGTH</a>.</p>
153
154 <p>The <a href="../compile.html#trace_size_limit">SQLITE_TRACE_SIZE_LIMIT</a> compile-time option limits the size of
155 bound parameter expansions. The <a href="../compile.html#omit_trace">SQLITE_OMIT_TRACE</a> compile-time
156 option causes sqlite3_expanded_sql() to always return NULL.</p>
157
158 <p>The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
159 are managed by SQLite and are automatically freed when the prepared
160 statement is finalized.
161 The string returned by sqlite3_expanded_sql(P), on the other hand,
162 is obtained from <a href="../c3ref/free.html">sqlite3_malloc()</a> and must be freed by the application
163 by passing it to <a href="../c3ref/free.html">sqlite3_free()</a>.</p>
164
165 <p>The sqlite3_normalized_sql() interface is only available if
166 the <a href="../compile.html#enable_normalize">SQLITE_ENABLE_NORMALIZE</a> compile-time option is defined.
167 </p><p>See also lists of
168 <a href="../c3ref/objlist.html">Objects</a>,
169 <a href="../c3ref/constlist.html">Constants</a>, and
170 <a href="../c3ref/funclist.html">Functions</a>.</p>
171