mirror of
https://github.com/cuberite/SQLiteCpp.git
synced 2025-08-04 17:56:13 -04:00
285 lines
33 KiB
HTML
285 lines
33 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.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('_database_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">Database.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_database_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 Database.h</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">#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> <span class="preprocessor">#include "<a class="code" href="_column_8h.html" title="Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.">Column.h</a>"</span></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> <span class="keyword">namespace </span>SQLite</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"></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @brief RAII management of a SQLite Database Connection.</span></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"> * A Database object manage a list of all SQLite Statements associated with the</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * underlying SQLite 3 database connection.</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"> * Resource Acquisition Is Initialization (RAII) means that the Database Connection</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * is opened in the constructor and closed in the destructor, so that there is</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * no need to worry about memory management or the validity of the underlying SQLite Connection.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="class_s_q_lite_1_1_database.html" title="RAII management of a SQLite Database Connection.">Database</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="class_s_q_lite_1_1_database.html#adab6e13caeb507948d0ee0b059b1a1af"> 31</a></span>  <span class="keyword">friend</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>; <span class="comment">// Give Statement constructor access to the mpSQLite Connection Handle</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @brief Open the provided database UTF-8 filename.</span></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"> * Uses sqlite3_open_v2() with readonly default flag, which is the opposite behavior</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * of the old sqlite3_open() function (READWRITE+CREATE).</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * This makes sense if you want to use it on a readonly filesystem</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * or to prevent creation of a void file when a required file is missing.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * Exception is thrown in case of error, then the Database object is NOT constructed.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @param[in] apFilename UTF-8 path/uri to the database file ("filename" sqlite3 parameter)</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @param[in] aFlags SQLITE_OPEN_READONLY/SQLITE_OPEN_READWRITE/SQLITE_OPEN_CREATE...</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>  <a class="code" href="class_s_q_lite_1_1_database.html#a3f63d182d0c627cec392921f5c0a75a3" title="Open the provided database UTF-8 filename.">Database</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* apFilename, <span class="keyword">const</span> <span class="keywordtype">int</span> aFlags = SQLITE_OPEN_READONLY); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></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="comment"> * @brief Close the SQLite database connection.</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"> * All SQLite statements must have been finalized before,</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * so all Statement objects must have been unregistered.</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="keyword">virtual</span> <a class="code" href="class_s_q_lite_1_1_database.html#a1f2acfa583fe30e3f068491101e32292" title="Close the SQLite database connection.">~Database</a>(<span class="keywordtype">void</span>) throw(); <span class="comment">// nothrow</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"> * @brief Shortcut to execute one or multiple statements without results.</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * This is useful for any kind of statements other than the Data Query Language (DQL) "SELECT" :</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * - Data Definition Language (DDL) statements "CREATE", "ALTER" and "DROP"</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * - Data Manipulation Language (DML) statements "INSERT", "UPDATE" and "DELETE"</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * - Data Control Language (DCL) statements "GRANT", "REVOKE", "COMMIT" and "ROLLBACK"</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"> * @see Statement::exec() to handle precompiled statements (for better performances) without results</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @see Statement::executeStep() to handle "SELECT" queries with results</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @param[in] apQueries one or multiple UTF-8 encoded, semicolon-separate SQL statements</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @return number of rows modified by those SQL statements (INSERT, UPDATE or DELETE)</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @throw SQLite::Exception in case of error</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="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.">exec</a>(const <span class="keywordtype">char</span>* apQueries); <span class="comment">// throw(SQLite::Exception);</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="comment"> /**</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @brief Shortcut to execute a one step query and fetch the first column of the result.</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * This is a shortcut to execute a simple statement with a single result.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * This should be used only for non reusable queries (else you should use a Statement with bind()).</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * This should be used only for queries with expected results (else an exception is fired).</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @warning WARNING: Be very careful with this dangerous method: you have to</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</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="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * (when the underlying temporary Statement and Column objects are destroyed)</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @see also Statement class for handling queries with multiple results</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param[in] apQuery an UTF-8 encoded SQL query</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @return a temporary Column object with the first column of result.</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @throw SQLite::Exception in case of error</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</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.">execAndGet</a>(const <span class="keywordtype">char</span>* apQuery); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</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 Shortcut to test if a table exists.</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"> * Table names are case sensitive.</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="comment"> * @param[in] apTableName an UTF-8 encoded case sensitive Table name</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"> * @return true if the table exists.</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="comment"> * @throw SQLite::Exception in case of error</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="keywordtype">bool</span> <a class="code" href="class_s_q_lite_1_1_database.html#a672bdb55f1fe7be6f9498bbab1a3f740" title="Shortcut to test if a table exists.">tableExists</a>(const <span class="keywordtype">char</span>* apTableName); <span class="comment">// throw(SQLite::Exception);</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></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="comment"> * @brief Set a busy handler that sleeps for a specified amount of time when a table is locked.</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"> * @param[in] aTimeoutMs Amount of milliseconds to wait before returning SQLITE_BUSY</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"><a class="code" href="class_s_q_lite_1_1_database.html#abf15791462a6997f0d7a942465924b52"> 115</a></span>  inline <span class="keywordtype">int</span> <a class="code" href="class_s_q_lite_1_1_database.html#abf15791462a6997f0d7a942465924b52" title="Set a busy handler that sleeps for a specified amount of time when a table is locked.">setBusyTimeout</a>(<span class="keywordtype">int</span> aTimeoutMs) <span class="comment">// throw(); nothrow</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  {</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> sqlite3_busy_timeout(mpSQLite, aTimeoutMs);</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</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 Get the rowid of the most recent successful INSERT into the database from the current connection.</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"> * @return Rowid of the most recent successful INSERT into the database, or 0 if there was none.</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"><a class="code" href="class_s_q_lite_1_1_database.html#af6833c6cbe9b315d496306c07ad38593"> 125</a></span>  <span class="keyword">inline</span> sqlite3_int64 <a class="code" href="class_s_q_lite_1_1_database.html#af6833c6cbe9b315d496306c07ad38593" title="Get the rowid of the most recent successful INSERT into the database from the current connection...">getLastInsertRowid</a>(<span class="keywordtype">void</span>) const <span class="comment">// throw(); nothrow</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  {</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">return</span> sqlite3_last_insert_rowid(mpSQLite);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  }</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></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="comment"> * @brief Return the filename used to open the database</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"><a class="code" href="class_s_q_lite_1_1_database.html#a3f27c66c43b3518ee4ccc6f5615216d2"> 133</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="class_s_q_lite_1_1_database.html#a3f27c66c43b3518ee4ccc6f5615216d2" title="Return the filename used to open the database.">getFilename</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">return</span> mFilename;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</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 Return UTF-8 encoded English language explanation of the most recent error.</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"><a class="code" href="class_s_q_lite_1_1_database.html#abfc1f4000cecde6f8d05cfe882ebde7c"> 141</a></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_database.html#abfc1f4000cecde6f8d05cfe882ebde7c" 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="l00142"></a><span class="lineno"> 142</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">return</span> sqlite3_errmsg(mpSQLite);</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  }</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">private</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> /// @{ Database must be non-copyable</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"></span> <a class="code" href="class_s_q_lite_1_1_database.html#a3f63d182d0c627cec392921f5c0a75a3" title="Open the provided database UTF-8 filename.">Database</a>(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_database.html" title="RAII management of a SQLite Database Connection.">Database</a>&);</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="class_s_q_lite_1_1_database.html" title="RAII management of a SQLite Database Connection.">Database</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_s_q_lite_1_1_database.html" title="RAII management of a SQLite Database Connection.">Database</a>&);<span class="comment"></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"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> /**</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @brief Check if aRet equal SQLITE_OK, else throw a SQLite::Exception with the SQLite error message</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</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="l00156"></a><span class="lineno"> 156</span> </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  sqlite3* mpSQLite; <span class="comment">//!< Pointer to SQLite Database Connection Handle</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span> std::string mFilename; <span class="comment">//!< UTF-8 filename used to open the database</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> </div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</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_8h.html">Database.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>
|