<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libsqlite3x: sqlite3x_settings_db.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>sqlite3x_settings_db.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef s11n_net_SQLITE3X_SETTINGS_DB_INCLUDED</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define s11n_net_SQLITE3X_SETTINGS_DB_INCLUDED 1</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include "sqlite3x.hpp"</span>
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="keyword">namespace </span>sqlite3x {
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> /**</span>
<a name="l00009"></a>00009 <span class="comment"> settings_db ia a very simplistic settings-data database for</span>
<a name="l00010"></a>00010 <span class="comment"> use with the sqlite3x database layer.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> Usage:</span>
<a name="l00013"></a>00013 <span class="comment"><pre></span>
<a name="l00014"></a>00014 <span class="comment"> settings_db db("my.db");</span>
<a name="l00015"></a>00015 <span class="comment"> db.set("one", 1 );</span>
<a name="l00016"></a>00016 <span class="comment"> db.set("two", 2.0 );</span>
<a name="l00017"></a>00017 <span class="comment"> db.set("a_string", "a string" );</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> std::string sval;</span>
<a name="l00020"></a>00020 <span class="comment"> assert( db.get( "a_string", sval ) );</span>
<a name="l00021"></a>00021 <span class="comment"></pre></span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment"> Obviously, an assert may be too harsh for what you're doing.</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment"> */</span>
<a name="l00026"></a><a class="code" href="classsqlite3x_1_1settings__db.html">00026</a> <span class="keyword">class </span><a class="code" href="classsqlite3x_1_1settings__db.html" title="settings_db ia a very simplistic settings-data database for use with the sqlite3x...">settings_db</a>
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> /**</span>
<a name="l00030"></a>00030 <span class="comment"> Calls open(dbname). This ctor will throw if dbname</span>
<a name="l00031"></a>00031 <span class="comment"> cannot be opened or if it is not a database.</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033 <span class="keyword">explicit</span> <a class="code" href="classsqlite3x_1_1settings__db.html#3d8dcf0eac62d336c83e4cfc4538d546" title="Creates an unopened database.">settings_db</a>( std::string <span class="keyword">const</span> & dbname );<span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment"> /**</span>
<a name="l00035"></a>00035 <span class="comment"> Creates an unopened database. You must call open()</span>
<a name="l00036"></a>00036 <span class="comment"> before you can use this object.</span>
<a name="l00037"></a>00037 <span class="comment"> */</span>
<a name="l00038"></a>00038 <a class="code" href="classsqlite3x_1_1settings__db.html#3d8dcf0eac62d336c83e4cfc4538d546" title="Creates an unopened database.">settings_db</a>();<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /**</span>
<a name="l00040"></a>00040 <span class="comment"> Closes this database.</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 <a class="code" href="classsqlite3x_1_1settings__db.html#591fbaf8632c0108dae95943c2334a3f" title="Closes this database.">~settings_db</a>();<span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /**</span>
<a name="l00044"></a>00044 <span class="comment"> Returns true if open() has succeeded.</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> <a class="code" href="classsqlite3x_1_1settings__db.html#4b88455aaf45c91a1e2e1b2c4a095330" title="Returns true if open() has succeeded.">is_open</a>() <span class="keyword">const</span>;<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /**</span>
<a name="l00048"></a>00048 <span class="comment"> Empties the database. Does not remove the db file.</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="classsqlite3x_1_1settings__db.html#0002a3ef140486324fb5c230d2817816" title="Empties the database.">clear</a>();<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /**</span>
<a name="l00052"></a>00052 <span class="comment"> Empties the database items matching the given WHERE</span>
<a name="l00053"></a>00053 <span class="comment"> clause. Does not remove the db file.</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> 'where' should be a full SQL where statement, e.g.:</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> "WHERE KEY LIKE 'x%'"</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> The field names in this db are KEY and VALUE.</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="classsqlite3x_1_1settings__db.html#0002a3ef140486324fb5c230d2817816" title="Empties the database.">clear</a>( std::string <span class="keyword">const</span> & where );
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /**</span>
<a name="l00064"></a>00064 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">int</span> val );<span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /**</span>
<a name="l00068"></a>00068 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, sqlite_int64 val );<span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /**</span>
<a name="l00072"></a>00072 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">bool</span> val );<span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /**</span>
<a name="l00076"></a>00076 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a>00078 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">double</span> val );<span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /**</span>
<a name="l00080"></a>00080 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, std::string <span class="keyword">const</span> & val );<span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /**</span>
<a name="l00084"></a>00084 <span class="comment"> Sets the given key/value pair.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <span class="keyword">set</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">char</span> <span class="keyword">const</span> * val );
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /**</span>
<a name="l00089"></a>00089 <span class="comment"> Fetches the given key from the db. If it is found,</span>
<a name="l00090"></a>00090 <span class="comment"> it is converted to the data type of val, val is</span>
<a name="l00091"></a>00091 <span class="comment"> assigned that value, and true is returned. If false</span>
<a name="l00092"></a>00092 <span class="comment"> is returned then val is unchanged.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> <span class="keyword">get</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">int</span> & val );<span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /** See get(string,int). */</span>
<a name="l00096"></a>00096 <span class="keywordtype">bool</span> <span class="keyword">get</span>( std::string <span class="keyword">const</span> & key, sqlite_int64 & val );<span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** See get(string,int). */</span>
<a name="l00098"></a>00098 <span class="keywordtype">bool</span> <span class="keyword">get</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">bool</span> & val );<span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** See get(string,int). */</span>
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> <span class="keyword">get</span>( std::string <span class="keyword">const</span> & key, <span class="keywordtype">double</span> & val );<span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** See get(string,int). */</span>
<a name="l00102"></a>00102 <span class="keywordtype">bool</span> <span class="keyword">get</span>( std::string <span class="keyword">const</span> & key, std::string & val );
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /**</span>
<a name="l00105"></a>00105 <span class="comment"> Opens the database dbname or throws on error.</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classsqlite3x_1_1settings__db.html#05c04d44972e1256a047b6552dd50e0f" title="Opens the database dbname or throws on error.">open</a>( std::string <span class="keyword">const</span> & dbname );<span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment"> /**</span>
<a name="l00109"></a>00109 <span class="comment"> Closes this database. Not normally necessary, as</span>
<a name="l00110"></a>00110 <span class="comment"> this happens during the destruction of this object.</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 <span class="keywordtype">void</span> <a class="code" href="classsqlite3x_1_1settings__db.html#f81930d81de7dacb06be505e3c280721" title="Closes this database.">close</a>();
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment"> /**</span>
<a name="l00115"></a>00115 <span class="comment"> If you want low-level info about the db, here's the</span>
<a name="l00116"></a>00116 <span class="comment"> handle to it. This will be null before open() has</span>
<a name="l00117"></a>00117 <span class="comment"> succeeded.</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 <a class="code" href="classsqlite3x_1_1sqlite3__connection.html" title="Represents a connection to an sqlite3 database.">sqlite3_connection</a> * <a class="code" href="classsqlite3x_1_1settings__db.html#ac367fcdcc139a2b88ed0a6102f237d2" title="If you want low-level info about the db, here&#39;s the handle to it.">db</a>();
<a name="l00120"></a>00120 <span class="keyword">private</span>:
<a name="l00121"></a>00121 <span class="keywordtype">void</span> init();
<a name="l00122"></a>00122 <a class="code" href="classsqlite3x_1_1sqlite3__connection.html" title="Represents a connection to an sqlite3 database.">sqlite3_connection</a> * m_db;
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124
<a name="l00125"></a>00125 } <span class="comment">// namespace whnet</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#endif // s11n_net_SQLITE3X_SETTINGS_DB_INCLUDED</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 18:20:37 2009 for libsqlite3x by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
a062ff4001da3fb37abf8a162b979587
>
files
>
44
