142 lines
5.6 KiB
HTML
142 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
|
<html><head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<link href="../sqlite.css" rel="stylesheet">
|
|
<title>Retrieving Statement SQL</title>
|
|
<!-- path=../ -->
|
|
</head>
|
|
<body>
|
|
<div class=nosearch>
|
|
<a href="../index.html">
|
|
<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
|
|
</a>
|
|
<div><!-- IE hack to prevent disappearing logo --></div>
|
|
<div class="tagline desktoponly">
|
|
Small. Fast. Reliable.<br>Choose any three.
|
|
</div>
|
|
<div class="menu mainmenu">
|
|
<ul>
|
|
<li><a href="../index.html">Home</a>
|
|
<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
|
|
<li class='wideonly'><a href='../about.html'>About</a>
|
|
<li class='desktoponly'><a href="../docs.html">Documentation</a>
|
|
<li class='desktoponly'><a href="../download.html">Download</a>
|
|
<li class='wideonly'><a href='../copyright.html'>License</a>
|
|
<li class='desktoponly'><a href="../support.html">Support</a>
|
|
<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
|
|
<li class='search' id='search_menubutton'>
|
|
<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
|
|
</ul>
|
|
</div>
|
|
<div class="menu submenu" id="submenu">
|
|
<ul>
|
|
<li><a href='../about.html'>About</a>
|
|
<li><a href='../docs.html'>Documentation</a>
|
|
<li><a href='../download.html'>Download</a>
|
|
<li><a href='../support.html'>Support</a>
|
|
<li><a href='../prosupport.html'>Purchase</a>
|
|
</ul>
|
|
</div>
|
|
<div class="searchmenu" id="searchmenu">
|
|
<form method="GET" action="../search">
|
|
<select name="s" id="searchtype">
|
|
<option value="d">Search Documentation</option>
|
|
<option value="c">Search Changelog</option>
|
|
</select>
|
|
<input type="text" name="q" id="searchbox" value="">
|
|
<input type="submit" value="Go">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>
|
|
function toggle_div(nm) {
|
|
var w = document.getElementById(nm);
|
|
if( w.style.display=="block" ){
|
|
w.style.display = "none";
|
|
}else{
|
|
w.style.display = "block";
|
|
}
|
|
}
|
|
function toggle_search() {
|
|
var w = document.getElementById("searchmenu");
|
|
if( w.style.display=="block" ){
|
|
w.style.display = "none";
|
|
} else {
|
|
w.style.display = "block";
|
|
setTimeout(function(){
|
|
document.getElementById("searchbox").focus()
|
|
}, 30);
|
|
}
|
|
}
|
|
function div_off(nm){document.getElementById(nm).style.display="none";}
|
|
window.onbeforeunload = function(e){div_off("submenu");}
|
|
/* Disable the Search feature if we are not operating from CGI, since */
|
|
/* Search is accomplished using CGI and will not work without it. */
|
|
if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
|
|
document.getElementById("search_menubutton").style.display = "none";
|
|
}
|
|
/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
|
|
function hideorshow(btn,obj){
|
|
var x = document.getElementById(obj);
|
|
var b = document.getElementById(btn);
|
|
if( x.style.display!='none' ){
|
|
x.style.display = 'none';
|
|
b.innerHTML='show';
|
|
}else{
|
|
x.style.display = '';
|
|
b.innerHTML='hide';
|
|
}
|
|
return false;
|
|
}
|
|
</script>
|
|
</div>
|
|
<!-- keywords: sqlite3_expanded_sql sqlite3_normalized_sql sqlite3_sql -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Retrieving Statement SQL</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
const char *sqlite3_sql(sqlite3_stmt *pStmt);
|
|
char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
|
|
const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
|
|
</pre></blockquote>
|
|
<p>
|
|
The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
|
|
SQL text used to create <a href="../c3ref/stmt.html">prepared statement</a> P if P was
|
|
created by <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a>, <a href="../c3ref/prepare.html">sqlite3_prepare_v3()</a>,
|
|
<a href="../c3ref/prepare.html">sqlite3_prepare16_v2()</a>, or <a href="../c3ref/prepare.html">sqlite3_prepare16_v3()</a>.
|
|
The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
|
|
string containing the SQL text of prepared statement P with
|
|
<a href="../lang_expr.html#varparam">bound parameters</a> expanded.
|
|
The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
|
|
string containing the normalized SQL text of prepared statement P. The
|
|
semantics used to normalize a SQL statement are unspecified and subject
|
|
to change. At a minimum, literal values will be replaced with suitable
|
|
placeholders.</p>
|
|
|
|
<p>For example, if a prepared statement is created using the SQL
|
|
text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
|
|
and parameter :xyz is unbound, then sqlite3_sql() will return
|
|
the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
|
|
will return "SELECT 2345,NULL".</p>
|
|
|
|
<p>The sqlite3_expanded_sql() interface returns NULL if insufficient memory
|
|
is available to hold the result, or if the result would exceed the
|
|
the maximum string length determined by the <a href="../c3ref/c_limit_attached.html#sqlitelimitlength">SQLITE_LIMIT_LENGTH</a>.</p>
|
|
|
|
<p>The <a href="../compile.html#trace_size_limit">SQLITE_TRACE_SIZE_LIMIT</a> compile-time option limits the size of
|
|
bound parameter expansions. The <a href="../compile.html#omit_trace">SQLITE_OMIT_TRACE</a> compile-time
|
|
option causes sqlite3_expanded_sql() to always return NULL.</p>
|
|
|
|
<p>The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
|
|
are managed by SQLite and are automatically freed when the prepared
|
|
statement is finalized.
|
|
The string returned by sqlite3_expanded_sql(P), on the other hand,
|
|
is obtained from <a href="../c3ref/free.html">sqlite3_malloc()</a> and must be free by the application
|
|
by passing it to <a href="../c3ref/free.html">sqlite3_free()</a>.
|
|
</p><p>See also lists of
|
|
<a href="objlist.html">Objects</a>,
|
|
<a href="constlist.html">Constants</a>, and
|
|
<a href="funclist.html">Functions</a>.</p>
|