mirror of
https://github.com/cuberite/SQLiteCpp.git
synced 2025-08-04 17:56:13 -04:00
434 lines
67 KiB
HTML
434 lines
67 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.3.1"/>
|
|
<title>SQLiteC++: src/Statement.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">SQLiteC++
|
|
 <span id="projectnumber">0.5.0</span>
|
|
</div>
|
|
<div id="projectbrief">SQLiteC++ is a smart and easy to use C++ SQLite3 wrapper.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.3.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('_statement_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Statement.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_statement_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file Statement.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * or copy at http://opensource.org/licenses/MIT)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <sqlite3.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="_exception_8h.html" title="Encapsulation of the error message from SQLite3 on a std::runtime_error.">Exception.h</a>"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>SQLite</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Forward declaration</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>Database;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>Column;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @brief RAII encapsulation of a prepared SQLite Statement.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * A Statement is a compiled SQL query ready to be executed step by step</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * to provide results one row at a time.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Resource Acquisition Is Initialization (RAII) means that the Statement</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * is compiled in the constructor and finalized in the destructor, so that there is</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * no need to worry about memory management or the validity of the underlying SQLite Statement.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">class </span><a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html" title="Shared pointer to the sqlite3_stmt SQLite Statement Object.">Ptr</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @brief Compile and register the SQL query for the provided SQLite Database Connection</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param[in] aDatabase the SQLite Database Connection</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param[in] apQuery an UTF-8 encoded query string </span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * Exception is thrown in case of error, then the Statement object is NOT constructed.</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="class_s_q_lite_1_1_statement.html#ab17c2c71de7224fcdf2252603e463cb9" title="Compile and register the SQL query for the provided SQLite Database Connection.">Statement</a>(<a class="code" href="class_s_q_lite_1_1_database.html" title="RAII management of a SQLite Database Connection.">Database</a>& aDatabase, <span class="keyword">const</span> <span class="keywordtype">char</span>* apQuery); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @brief Finalize and unregister the SQL query from the SQLite Database Connection.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a5ca54a9bf0fba1af2a077c8fe5579f00" title="Finalize and unregister the SQL query from the SQLite Database Connection.">~Statement</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>(); <span class="comment">// nothrow</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @brief Reset the statement to make it ready for a new execution.</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#aef7da8a8dd11f1604d10aab9a025cb54" title="Reset the statement to make it ready for a new execution.">reset</a>(<span class="keywordtype">void</span>); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> ////////////////////////////////////////////////////////////////////////////</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> <span class="comment">// Bind a value to a parameter of the SQL statement,</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// in the form "?" (unnamed), "?NNN", ":VVV", "@VVV" or "$VVV".</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Can use the parameter index, starting from "1", to the higher NNN value,</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// or the complete parameter name "?NNN", ":VVV", "@VVV" or "$VVV"</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// (prefixed with the corresponding sign "?", ":", "@" or "$")</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// Note that for text and blob values, the SQLITE_TRANSIENT flag is used,</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// which tell the sqlite library to make its own copy of the data before the bind() call returns.</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// This choice is done to prevent any common misuses, like passing a pointer to a </span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// dynamic allocated and temporary variable (a std::string for instance).</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// This is under-optimized for static data (a static text define in code)</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// as well as for dynamic allocated buffer which could be transfer to sqlite</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// instead of being copied.</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @brief Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> <span class="keywordtype">int</span>& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @brief Bind a 64bits int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> sqlite3_int64& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @brief Bind a double (64bits float) value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> <span class="keywordtype">double</span>& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief Bind a string value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> std::string& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @brief Bind a text value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> <span class="keywordtype">char</span>* apValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @brief Bind a binary blob value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex, <span class="keyword">const</span> <span class="keywordtype">void</span>* apValue, <span class="keyword">const</span> <span class="keywordtype">int</span> aSize) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @brief Bind a NULL value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Bind an int value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> <span class="keywordtype">int</span>& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @brief Bind a 64bits int value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> sqlite3_int64& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief Bind a double (64bits float) value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> <span class="keywordtype">double</span>& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @brief Bind a string value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> std::string& aValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @brief Bind a text value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> <span class="keywordtype">char</span>* apValue) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @brief Bind a binary blob value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @note This uses the SQLITE_TRANSIENT flag, making a copy of the data, for SQLite internal use</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName, <span class="keyword">const</span> <span class="keywordtype">void</span>* apValue, <span class="keyword">const</span> <span class="keywordtype">int</span> aSize) ; <span class="comment">// throw(SQLite::Exception);</span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @brief Bind a NULL value to a named parameter "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement (aIndex >= 1)</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a265f4a381704d7ce94855d49db2c52e9" title="Bind an int value to a parameter "?", "?NNN", ":VVV", "@VVV" or "$VVV" in the SQL prepared statement ...">bind</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apName); <span class="comment">// throw(SQLite::Exception); // bind NULL value</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> ////////////////////////////////////////////////////////////////////////////</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @brief Execute a step of the prepared query to fetch one row of results.</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * While true is returned, a row of results is available, and can be accessed</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * thru the getColumn() method</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @see exec() execute a one-step prepared statement with no expected result</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @see Database::exec() is a shortcut to execute one or multiple statements without results</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @return - true (SQLITE_ROW) if there is another row ready : you can call getColumn(N) to get it</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * then you have to call executeStep() again to fetch more rows until the query is finished</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * - false (SQLITE_DONE) if the query has finished executing : there is no (more) row of result</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * (case of a query with no result, or after N rows fetched successfully)</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @throw SQLite::Exception in case of error</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_statement.html#aa7f29464b5fbe4b8da92d769e52472d8" title="Execute a step of the prepared query to fetch one row of results.">executeStep</a>(<span class="keywordtype">void</span>); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @brief Execute a one-step query with no expected result.</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * This method is useful for any kind of statements other than the Data Query Language (DQL) "SELECT" :</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * - Data Definition Language (DDL) statements "CREATE", "ALTER" and "DROP"</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * - Data Manipulation Language (DML) statements "INSERT", "UPDATE" and "DELETE"</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * - Data Control Language (DCL) statements "GRANT", "REVOKE", "COMMIT" and "ROLLBACK"</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * It is similar to Database::exec(), but using a precompiled statement, it adds :</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * - the ability to bind() arguments to it (best way to insert data),</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * - reusing it allows for better performances (efficent for multiple insersion).</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @see executeStep() execute a step of the prepared query to fetch one row of results</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @see Database::exec() is a shortcut to execute one or multiple statements without results</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * @return number of row modified by this SQL statement (INSERT, UPDATE or DELETE)</span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @throw SQLite::Exception in case of error, or if row of results are returned !</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">int</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a6d78e0ae6321bc695d21f1bada8bbadb" title="Execute a one-step query with no expected result.">exec</a>(<span class="keywordtype">void</span>); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> ////////////////////////////////////////////////////////////////////////////</span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @brief Return a copie of the column data specified by its index</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * Can be used to access the data of the current row of result when applicable,</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * while the executeStep() method returns true.</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * Throw an exception if there is no row to return a Column from :</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * - before any executeStep() call</span></div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * - after the last executeStep() returned false</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * - after a reset() call</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * Throw an exception if the specified index is out of the [0, getColumnCount()) range.</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @param[in] aIndex Index of the column, starting at 0</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @note This method is no more const, starting in v0.5,</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * which reflects the fact that the returned Column object will</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * share the ownership of the underlying sqlite3_stmt.</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * @warning The resulting Column object must not be memorized "as-is".</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * Is is only a wrapper arround the current result row, so it is only valid</span></div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * while the row from the Statement remains valid, that is only until next executeStep() call.</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * Thus, you should instead extract immediately its data (getInt(), getText()...)</span></div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * and use or copy this data for any later usage.</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <a class="code" href="class_s_q_lite_1_1_column.html" title="Encapsulation of a Column in a row of the result pointed by the prepared Statement.">Column</a> <a class="code" href="class_s_q_lite_1_1_statement.html#a5b7c9372b9023a86e7242d47052f06f7" title="Return a copie of the column data specified by its index.">getColumn</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @brief Test if the column value is NULL</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @param[in] aIndex Index of the column, starting at 0</span></div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @return true if the column value is NULL</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a03790608e4b945d12605e1cadf2fd9d9" title="Test if the column value is NULL.">isColumnNull</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> aIndex) <span class="keyword">const</span>; <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> ////////////////////////////////////////////////////////////////////////////</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> /// @brief Return the UTF-8 SQL Query.</span></div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html#ab6e3b57d2b6e909b3852b927801e36d6"> 225</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="class_s_q_lite_1_1_statement.html#ab6e3b57d2b6e909b3852b927801e36d6" title="Return the UTF-8 SQL Query.">getQuery</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">return</span> mQuery;</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  }<span class="comment"></span></div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> /// @brief Return the number of columns in the result set returned by the prepared statement</span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html#a97dcdc3e791836250f707fdf77fde4a4"> 230</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a97dcdc3e791836250f707fdf77fde4a4" title="Return the number of columns in the result set returned by the prepared statement.">getColumnCount</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordflow">return</span> mColumnCount;</div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  }<span class="comment"></span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /// @brief true when a row has been fetched with executeStep()</span></div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html#a28e4f907c6455cd2bda8e6baa5856a40"> 235</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a28e4f907c6455cd2bda8e6baa5856a40" title="true when a row has been fetched with executeStep()">isOk</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keywordflow">return</span> mbOk;</div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  }<span class="comment"></span></div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> /// @brief true when the last executeStep() had no more row to fetch</span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html#a387067802ddcb66baa9e38a2d6cbae85"> 240</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_statement.html#a387067802ddcb66baa9e38a2d6cbae85" title="true when the last executeStep() had no more row to fetch">isDone</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordflow">return</span> mbDone;</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  }<span class="comment"></span></div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> /// @brief Return UTF-8 encoded English language explanation of the most recent error.</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement.html#a06f6b6916121f22c60d791dbbb1c4ace"> 245</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_s_q_lite_1_1_statement.html#a06f6b6916121f22c60d791dbbb1c4ace" title="Return UTF-8 encoded English language explanation of the most recent error.">errmsg</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordflow">return</span> sqlite3_errmsg(mStmtPtr);</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  }</div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="keyword">public</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * @brief Shared pointer to the sqlite3_stmt SQLite Statement Object.</span></div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * Manage the finalization of the sqlite3_stmt with a reference counter.</span></div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * This is a internal class, not part of the API (hence full documentation is in the cpp).</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html"> 258</a></span>  <span class="keyword">class </span><a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html" title="Shared pointer to the sqlite3_stmt SQLite Statement Object.">Ptr</a></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  {</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment">// Prepare the statement and initialize its reference counter</span></div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html#a18aed2d776048a94e862fe744b84d26c" title="Prepare the statement and initialize its reference counter.">Ptr</a>(sqlite3* apSQLite, std::string& aQuery);</div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">// Copy constructor increments the ref counter</span></div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html#a18aed2d776048a94e862fe744b84d26c" title="Prepare the statement and initialize its reference counter.">Ptr</a>(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html" title="Shared pointer to the sqlite3_stmt SQLite Statement Object.">Ptr</a>& aPtr);</div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="comment">// Decrement the ref counter and finalize the sqlite3_stmt when it reaches 0</span></div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html#a43718f0447c7531653bf06eab0cf462b" title="Decrement the ref counter and finalize the sqlite3_stmt when it reaches 0.">~Ptr</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>(); <span class="comment">// nothrow (no virtual destructor needed here)</span></div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> /// @brief Inline cast operator returning the pointer to SQLite Database Connection Handle</span></div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html#a23d1f687d47228855df6292a0b707f28"> 269</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keyword">operator</span> sqlite3*() <span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  {</div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keywordflow">return</span> mpSQLite;</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  }</div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> /// @brief Inline cast operator returning the pointer to SQLite Statement Object</span></div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html#a1354530f6dcd2f8ae983f753b2e1f1dd"> 275</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keyword">operator</span> sqlite3_stmt*() <span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  {</div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordflow">return</span> mpStmt;</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  }</div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keyword">private</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> /// @{ Unused/forbidden copy operator</span></div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"></span> <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html" title="Shared pointer to the sqlite3_stmt SQLite Statement Object.">Ptr</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_statement_1_1_ptr.html" title="Shared pointer to the sqlite3_stmt SQLite Statement Object.">Ptr</a>& aPtr);<span class="comment"></span></div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> /// @}</span></div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  sqlite3* mpSQLite; <span class="comment">//!< Pointer to SQLite Database Connection Handle</span></div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"></span> sqlite3_stmt* mpStmt; <span class="comment">//!< Pointer to SQLite Statement Object</span></div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* mpRefCount; <span class="comment">//!< Pointer to the heap allocated reference counter of the sqlite3_stmt (to share it with Column objects)</span></div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"></span> };</div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="keyword">private</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> /// @{ Statement must be non-copyable</span></div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"></span> <a class="code" href="class_s_q_lite_1_1_statement.html#ab17c2c71de7224fcdf2252603e463cb9" title="Compile and register the SQL query for the provided SQLite Database Connection.">Statement</a>(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a>&);</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a>&);<span class="comment"></span></div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> /// @}</span></div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @brief Check if a return code equals SQLITE_OK, else throw a SQLite::Exception with the SQLite error message</span></div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * @param[in] SQLite return code to test against the SQLITE_OK expected value</span></div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordtype">void</span> check(<span class="keyword">const</span> <span class="keywordtype">int</span> aRet) <span class="keyword">const</span>; <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  std::string mQuery; <span class="comment">//!< UTF-8 SQL Query</span></div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"></span> Ptr mStmtPtr; <span class="comment">//!< Shared Pointer to the prepared SQLite Statement Object</span></div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"></span> <span class="keywordtype">int</span> mColumnCount; <span class="comment">//!< Number of columns in the result of the prepared statement</span></div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"></span> <span class="keywordtype">bool</span> mbOk; <span class="comment">//!< true when a row has been fetched with executeStep()</span></div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"></span> <span class="keywordtype">bool</span> mbDone; <span class="comment">//!< true when the last executeStep() had no more row to fetch</span></div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"></span>};</div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> } <span class="comment">// namespace SQLite</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_statement_8h.html">Statement.h</a></li>
|
|
<li class="footer">Generated on Sun Mar 10 2013 18:17:22 for SQLiteC++ by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|