mirror of
https://github.com/cuberite/SQLiteCpp.git
synced 2025-08-04 17:56:13 -04:00
204 lines
20 KiB
HTML
204 lines
20 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/Database.cpp 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('_database_8cpp_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">Database.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_database_8cpp.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 Database.cpp</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Management of a SQLite Database Connection.</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">#include "<a class="code" href="_database_8h.html" title="Management of a SQLite Database Connection.">Database.h</a>"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="_statement_8h.html" title="A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result...">Statement.h</a>"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span>SQLite</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</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> <span class="comment">// Open the provided database UTF-8 filename with SQLITE_OPEN_xxx provided flags.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#a3f63d182d0c627cec392921f5c0a75a3"> 18</a></span> <a class="code" href="class_s_q_lite_1_1_database.html#a3f63d182d0c627cec392921f5c0a75a3" title="Open the provided database UTF-8 filename.">Database::Database</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apFilename, <span class="keyword">const</span> <span class="keywordtype">int</span> aFlags <span class="comment">/*= SQLITE_OPEN_READONLY*/</span>) : <span class="comment">// throw(SQLite::Exception)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  mpSQLite(NULL),</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  mFilename(apFilename)</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">int</span> ret = sqlite3_open_v2(apFilename, &mpSQLite, aFlags, NULL);</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">if</span> (SQLITE_OK != ret)</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  std::string strerr = sqlite3_errmsg(mpSQLite);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  sqlite3_close(mpSQLite); <span class="comment">// close is required even in case of error on opening</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">throw</span> <a class="code" href="class_s_q_lite_1_1_exception.html" title="Encapsulation of the error message from SQLite3, based on std::runtime_error.">SQLite::Exception</a>(strerr);</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Close the SQLite database connection.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#a1f2acfa583fe30e3f068491101e32292"> 32</a></span> <a class="code" href="class_s_q_lite_1_1_database.html#a1f2acfa583fe30e3f068491101e32292" title="Close the SQLite database connection.">Database::~Database</a>(<span class="keywordtype">void</span>) throw() <span class="comment">// nothrow</span></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="keywordtype">int</span> ret = sqlite3_close(mpSQLite);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Never throw an exception in a destructor</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">//std::cout << sqlite3_errmsg(mpSQLite) << std::endl;</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="_exception_8h.html#a09377ccaaa7b9131802787787c13c634">SQLITE_CPP_ASSERT</a> (SQLITE_OK == ret);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Shortcut to execute one or multiple SQL statements without results (UPDATE, INSERT, ALTER, COMMIT...).</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#a0158bf527b79317679c9cf1e6daf1c43"> 41</a></span> <span class="keywordtype">int</span> <a class="code" href="class_s_q_lite_1_1_database.html#a0158bf527b79317679c9cf1e6daf1c43" title="Shortcut to execute one or multiple statements without results.">Database::exec</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apQueries) <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">int</span> ret = sqlite3_exec(mpSQLite, apQueries, NULL, NULL, NULL);</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  check(ret);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// Return the number of rows modified by those SQL statements (INSERT, UPDATE or DELETE)</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> sqlite3_changes(mpSQLite);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Shortcut to execute a one step query and fetch the first column of the result.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// WARNING: Be very careful with this dangerous method: you have to</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// make a COPY OF THE result, else it will be destroy before the next line</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// (when the underlying temporary Statement and Column objects are destroyed)</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// this is an issue only for pointer type result (ie. char* and blob)</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// (use the Column copy-constructor)</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#ac828a49fab425564e65c95ff1fd03c74"> 56</a></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_database.html#ac828a49fab425564e65c95ff1fd03c74" title="Shortcut to execute a one step query and fetch the first column of the result.">Database::execAndGet</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apQuery) <span class="comment">// throw(SQLite::Exception)</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a> query(*<span class="keyword">this</span>, apQuery);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  query.<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>();</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> query.<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>(0);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> }</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// Shortcut to test if a table exists.</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#a672bdb55f1fe7be6f9498bbab1a3f740"> 64</a></span> <span class="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_database.html#a672bdb55f1fe7be6f9498bbab1a3f740" title="Shortcut to test if a table exists.">Database::tableExists</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apTableName) <span class="comment">// throw(SQLite::Exception)</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="class_s_q_lite_1_1_statement.html" title="RAII encapsulation of a prepared SQLite Statement.">Statement</a> query(*<span class="keyword">this</span>, <span class="stringliteral">"SELECT count(*) FROM sqlite_master WHERE type='table' AND name=?"</span>);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  query.<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>(1, apTableName);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  query.<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>();</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">int</span> Nb = query.<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>(0);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> (1 == Nb);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Check if aRet equal SQLITE_OK, else throw a SQLite::Exception with the SQLite error message</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">void</span> Database::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="l00075"></a><span class="lineno"> 75</span> {</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">if</span> (SQLITE_OK != aRet)</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  {</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">throw</span> <a class="code" href="class_s_q_lite_1_1_exception.html" title="Encapsulation of the error message from SQLite3, based on std::runtime_error.">SQLite::Exception</a>(sqlite3_errmsg(mpSQLite));</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</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="_database_8cpp.html">Database.cpp</a></li>
|
|
<li class="footer">Generated on Sun Mar 10 2013 18:17:21 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>
|