brennen
/
worm

<!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"/><title>WORM: WSql::WSqliteDriver Class Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><link href="search/search.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="search/search.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css"/></head><body onload='searchBox.OnSelectItem(0);'><!-- Generated by Doxygen 1.7.3 --><script type="text/javascript"><!--var searchBox = new SearchBox("searchBox", "search",false,'Search');--></script><script type="text/javascript">function hasClass(ele,cls) {  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));}
function addClass(ele,cls) {  if (!this.hasClass(ele,cls)) ele.className += " "+cls;}
function removeClass(ele,cls) {  if (hasClass(ele,cls)) {    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');    ele.className=ele.className.replace(reg,' ');  }}
function toggleVisibility(linkObj) { var base = linkObj.getAttribute('id'); var summary = document.getElementById(base + '-summary'); var content = document.getElementById(base + '-content'); var trigger = document.getElementById(base + '-trigger'); if ( hasClass(linkObj,'closed') ) {   summary.style.display = 'none';   content.style.display = 'block';   trigger.src = 'open.png';   removeClass(linkObj,'closed');   addClass(linkObj,'opened'); } else if ( hasClass(linkObj,'opened') ) {   summary.style.display = 'block';   content.style.display = 'none';   trigger.src = 'closed.png';   removeClass(linkObj,'opened');   addClass(linkObj,'closed'); } return false;}</script><div id="top"><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;">  <td id="projectlogo"><img alt="Logo" src="worm_sm.png"></td>  <td style="padding-left: 0.5em;">   <div id="projectname">WORM&#160;<span id="projectnumber">0.2</span></div>   <div id="projectbrief">A C++ DAL/ORM code generation framework</div>  </td> </tr> </tbody></table></div>  <div id="navrow1" class="tabs">    <ul class="tablist">      <li><a href="index.html"><span>Main&#160;Page</span></a></li>      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>      <li><a href="namespaces.html"><span>Namespaces</span></a></li>      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>      <li><a href="files.html"><span>Files</span></a></li>      <li id="searchli">        <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="annotated.html"><span>Class&#160;List</span></a></li>      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>    </ul>  </div>  <div id="nav-path" class="navpath">    <ul>      <li class="navelem"><a class="el" href="namespace_w_sql.html">WSql</a>      </li>      <li class="navelem"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html">WSqliteDriver</a>      </li>    </ul>  </div></div><div class="header">  <div class="summary"><a href="#pub-methods">Public Member Functions</a>  </div>  <div class="headertitle"><h1>WSql::WSqliteDriver Class Reference</h1>  </div></div><div class="contents"><!-- doxytag: class="WSql::WSqliteDriver" --><!-- doxytag: inherits="WSql::WSqlDriver" --><p><code>#include &lt;<a class="el" href="wsqlitedriver_8h_source.html">wsqlitedriver.h</a>&gt;</code></p><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for WSql::WSqliteDriver:</div><div id="dynsection-0-summary" class="dynsummary" style="display:block;"></div><div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center">  <img src="class_w_sql_1_1_w_sqlite_driver.png" usemap="#WSql::WSqliteDriver_map" alt=""/>  <map id="WSql::WSqliteDriver_map" name="WSql::WSqliteDriver_map"><area href="class_w_sql_1_1_w_sql_driver.html" alt="WSql::WSqlDriver" shape="rect" coords="0,0,123,24"/></map> </div></div>
<p><a href="class_w_sql_1_1_w_sqlite_driver-members.html">List of all members.</a></p><table class="memberdecls"><tr><td colspan="2"><h2><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a9c3c650f052fe64490b0c0607c75a379">WSqliteDriver</a> (<a class="el" href="class_w_sql_1_1_w_sql_database.html">WSqlDatabase</a> *db)</td></tr><tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aedc78f4e6972c7df4388f8e960424d53">~WSqliteDriver</a> ()</td></tr><tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a401f5a03ca5d1e288ade6598c5379a20">open</a> ()</td></tr><tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#ac80543216d537dab91b382488042c416">close</a> ()</td></tr><tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434">query</a> (std::string sql)</td></tr><tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the query <em>sql</em> to the database.  <a href="#a4ba7ea260dd263e74d9c16c58e655434"></a><br/></td></tr><tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_result.html">WSqlResult</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a1cf0f135668cdd8299995c1ffff72724">result</a> (bool iscached=true)</td></tr><tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aa7796f2d18f519f24016a9fa1f9e2f0b">tableNames</a> ()</td></tr><tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_table.html">WSqlTable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aa74cc6840682c0ae5fe9bb2e4aa76a4d">tableMetaData</a> (const std::string &amp;tableName)</td></tr></table><hr/><a name="_details"></a><h2>Detailed Description</h2><div class="textblock"><p>driver for SQlite3 databases This class provides a driver for SQlite3 databases.</p><p>DANGER: USE AT YOUR OWN RISK!! NOT RECOMMENDED.</p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000014">Todo:</a></b></dt><dd>This driver is unfinished. Basic functionality is there but it is not, ah, elegant. Metadata is incomplete, all results are cached locally and there may be strange behavior. Basically I have done enough to get sufficient metadata for the ORM generator (except indices still) and <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434" title="Send the query sql to the database.">query()</a> will perform the query and return a result via <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a1cf0f135668cdd8299995c1ffff72724">getResult()</a>. <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aa7796f2d18f519f24016a9fa1f9e2f0b">tableNames()</a> works and <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#aa74cc6840682c0ae5fe9bb2e4aa76a4d">tableMetaData()</a> works as well (with the above caveats). Transactions are not supported and I seriously doubt that this is thread safe. It quite is crude at the moment - your milage may vary. It _might_ work for you but at this point I don't recommend it for production (10/10/2011)</dd></dl><p>(at a minimum) : </p><ul><li>finish initializing the indices and fully initialize a <a class="el" href="class_w_sql_1_1_w_sql_table.html" title="WSqlTable is an abstraction for a single table, collection or view in a database.">WSqlTable</a>. </li><li>clean up some of the logic and make use of <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434" title="Send the query sql to the database.">query()</a> rather than reproducing code for queries. </li><li>break up <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434" title="Send the query sql to the database.">query()</a> and handle errors properly </li><li>see the note by <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a4ba7ea260dd263e74d9c16c58e655434" title="Send the query sql to the database.">query()</a> about creating a result set so that fields exist and have names even if the value is empty (ie. NULL). This is a valid return in SQL and should be there! </li><li>implement transactions </li><li>if we _must_ parse the create statements .. this needs redone correctly - it is a bit buggy, awkward and very inefficient (a quick fix). Alternately, figure out some way to get sqlite to provide the metadata correctly and reliably at _any_ time (meaning, even if a table happens to be empty ..). </li><li>redo the columns mapping mess .. std::map is overkill, a quick fix.. </li><li>general safety checks, eliminate code duplication, memory checks, testing .. etc.</li></ul><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sql_driver.html" title="The WSqlDriver class is an abstract base class for database drivers.">WSqlDriver</a> WSqlMysqlDriver </dd></dl>
<p>Definition at line <a class="el" href="wsqlitedriver_8h_source.html#l00033">33</a> of file <a class="el" href="wsqlitedriver_8h_source.html">wsqlitedriver.h</a>.</p></div><hr/><h2>Constructor &amp; Destructor Documentation</h2><a class="anchor" id="a9c3c650f052fe64490b0c0607c75a379"></a><!-- doxytag: member="WSql::WSqliteDriver::WSqliteDriver" ref="a9c3c650f052fe64490b0c0607c75a379" args="(WSqlDatabase *db)" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">WSql::WSqliteDriver::WSqliteDriver </td>          <td>(</td>          <td class="paramtype"><a class="el" href="class_w_sql_1_1_w_sql_database.html">WSqlDatabase</a> *&#160;</td>          <td class="paramname"><em>db</em></td><td>)</td>          <td></td>        </tr>      </table></div><div class="memdoc">
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00212">212</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="aedc78f4e6972c7df4388f8e960424d53"></a><!-- doxytag: member="WSql::WSqliteDriver::~WSqliteDriver" ref="aedc78f4e6972c7df4388f8e960424d53" args="()" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">WSql::WSqliteDriver::~WSqliteDriver </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td></td>        </tr>      </table></div><div class="memdoc">
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00217">217</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><hr/><h2>Member Function Documentation</h2><a class="anchor" id="ac80543216d537dab91b382488042c416"></a><!-- doxytag: member="WSql::WSqliteDriver::close" ref="ac80543216d537dab91b382488042c416" args="()" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">void WSql::WSqliteDriver::close </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc"><p>Derived classes must reimplement this pure virtual function in order to close the database connection. Return true on success, false on failure.</p><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a401f5a03ca5d1e288ade6598c5379a20">open()</a>, setOpen() </dd></dl>
<p>Implements <a class="el" href="class_w_sql_1_1_w_sql_driver.html#a17afc1e43627a2a952e76d04420dead0">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00262">262</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="a401f5a03ca5d1e288ade6598c5379a20"></a><!-- doxytag: member="WSql::WSqliteDriver::open" ref="a401f5a03ca5d1e288ade6598c5379a20" args="()" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">bool WSql::WSqliteDriver::open </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc"><p>Derived classes must reimplement this pure virtual function to open a database connection on the database</p><p>The function must return true on success and false on failure.</p><dl class="see"><dt><b>See also:</b></dt><dd>setOpen() </dd></dl>
<p>Implements <a class="el" href="class_w_sql_1_1_w_sql_driver.html#a2a1f251900715cd1e45aa7a565a57253">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00241">241</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="a4ba7ea260dd263e74d9c16c58e655434"></a><!-- doxytag: member="WSql::WSqliteDriver::query" ref="a4ba7ea260dd263e74d9c16c58e655434" args="(std::string sql)" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">bool WSql::WSqliteDriver::query </td>          <td>(</td>          <td class="paramtype">std::string&#160;</td>          <td class="paramname"><em>sql</em></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc">
<p>Send the query <em>sql</em> to the database. </p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000016">Todo:</a></b></dt><dd>refactor this using metadata to construct a proper result set .. sqlite doesn't return things in orderly fashion - if a field is empty (i.e. NULL) it just doesn't include it in the results (ARG!), i _think_ and other strange random behavior is observed ..- so, we need to construct a skeleton result set from metadata and then fill it leaving the appropriate gaps such that the field name will _always_ be there. We can't simply refer to tableMetaData as it may be a join or such - which would mean parsing the query, etc..ugly The problem is that we cannot rely on sqlite to return metadata if, for instance, the query returns no results.. Consider using sqlite3_column_metadata. Also, some of this might be better moved to <a class="el" href="class_w_sql_1_1_w_sqlite_driver.html#a1cf0f135668cdd8299995c1ffff72724">getResult()</a></dd></dl><dl><dt><b>Parameters:</b></dt><dd>  <table class="params">    <tr><td class="paramname">std::string</td><td>sql containing the query string </td></tr>  </table>  </dd></dl><dl><dt><b>Return values:</b></dt><dd>  <table class="retval">    <tr><td class="paramname">bool</td><td></td></tr>  </table>  </dd></dl>
<p>Implements <a class="el" href="class_w_sql_1_1_w_sql_driver.html#ad15803a5c5d4e8e1d80fec885ed13203">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00292">292</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="a1cf0f135668cdd8299995c1ffff72724"></a><!-- doxytag: member="WSql::WSqliteDriver::result" ref="a1cf0f135668cdd8299995c1ffff72724" args="(bool iscached=true)" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_result.html">WSqlResult</a> * WSql::WSqliteDriver::result </td>          <td>(</td>          <td class="paramtype">bool&#160;</td>          <td class="paramname"><em>iscached</em> = <code>true</code></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc">
<p>Reimplemented from <a class="el" href="class_w_sql_1_1_w_sql_driver.html#ae5670416af2dc36911bc29478e5ad0e3">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00352">352</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="aa74cc6840682c0ae5fe9bb2e4aa76a4d"></a><!-- doxytag: member="WSql::WSqliteDriver::tableMetaData" ref="aa74cc6840682c0ae5fe9bb2e4aa76a4d" args="(const std::string &amp;tableName)" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_table.html">WSqlTable</a> WSql::WSqliteDriver::tableMetaData </td>          <td>(</td>          <td class="paramtype">const std::string &amp;&#160;</td>          <td class="paramname"><em>tableName</em></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc">
<p>Implements <a class="el" href="class_w_sql_1_1_w_sql_driver.html#a2574f1f0d2083f1b0e05f4721f870a74">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00384">384</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><a class="anchor" id="aa7796f2d18f519f24016a9fa1f9e2f0b"></a><!-- doxytag: member="WSql::WSqliteDriver::tableNames" ref="aa7796f2d18f519f24016a9fa1f9e2f0b" args="()" --><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">std::vector&lt; std::string &gt; WSql::WSqliteDriver::tableNames </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td><code> [virtual]</code></td>        </tr>      </table></div><div class="memdoc"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000017">Todo:</a></b></dt><dd>support table type flag .. views, information schema </dd></dl>
<p>Implements <a class="el" href="class_w_sql_1_1_w_sql_driver.html#adc7f0845587544ad92e3079542e844db">WSql::WSqlDriver</a>.</p>
<p>Definition at line <a class="el" href="wsqlitedriver_8cpp_source.html#l00360">360</a> of file <a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a>.</p>
</div></div><hr/>The documentation for this class was generated from the following files:<ul><li>src/sql/drivers/<a class="el" href="wsqlitedriver_8h_source.html">wsqlitedriver.h</a></li><li>src/sql/drivers/<a class="el" href="wsqlitedriver_8cpp_source.html">wsqlitedriver.cpp</a></li></ul></div><!--- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) --><div id="MSearchResultsWindow"><iframe src="" frameborder="0"         name="MSearchResults" id="MSearchResults"></iframe></div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:46 for WORM by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address></body></html>