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: src/sql/wsqldriver.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>      <li class="current"><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="files.html"><span>File&#160;List</span></a></li>      <li><a href="globals.html"><span>File&#160;Members</span></a></li>    </ul>  </div><div class="header">  <div class="headertitle"><h1>src/sql/wsqldriver.h</h1>  </div></div><div class="contents"><a href="wsqldriver_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span><a name="l00002"></a>00002 <span class="comment"> *    WORM - a DAL/ORM code generation framework</span><a name="l00003"></a>00003 <span class="comment"> *    Copyright (C) 2011  Erik Winn &lt;erikwinnmail@yahoo.com&gt;</span><a name="l00004"></a>00004 <span class="comment"> * </span><a name="l00005"></a>00005 <span class="comment"> *    This program is free software: you can redistribute it and/or modify</span><a name="l00006"></a>00006 <span class="comment"> *    it under the terms of the GNU General Public License as published by</span><a name="l00007"></a>00007 <span class="comment"> *    the Free Software Foundation, either version 3 of the License, or</span><a name="l00008"></a>00008 <span class="comment"> *    (at your option) any later version.</span><a name="l00009"></a>00009 <span class="comment"> * </span><a name="l00010"></a>00010 <span class="comment"> *    This program is distributed in the hope that it will be useful,</span><a name="l00011"></a>00011 <span class="comment"> *    but WITHOUT ANY WARRANTY; without even the implied warranty of</span><a name="l00012"></a>00012 <span class="comment"> *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span><a name="l00013"></a>00013 <span class="comment"> *    GNU General Public License for more details.</span><a name="l00014"></a>00014 <span class="comment"> * </span><a name="l00015"></a>00015 <span class="comment"> *    You should have received a copy of the GNU General Public License</span><a name="l00016"></a>00016 <span class="comment"> *    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span><a name="l00017"></a>00017 <span class="comment"> */</span><a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef WSQLDRIVER_H</span><a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define WSQLDRIVER_H</span><a name="l00021"></a>00021 <span class="preprocessor"></span><a name="l00022"></a>00022 <span class="preprocessor">#include &lt;string&gt;</span><a name="l00023"></a>00023 <span class="preprocessor">#include &quot;<a class="code" href="wsqldatabase_8h.html">wsqldatabase.h</a>&quot;</span><a name="l00024"></a>00024 <span class="preprocessor">#include &quot;<a class="code" href="wsqlerror_8h.html">wsqlerror.h</a>&quot;</span><a name="l00025"></a>00025 <span class="preprocessor">#include &quot;<a class="code" href="wsqlresult_8h.html">wsqlresult.h</a>&quot;</span><a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">namespace </span>WSql<a name="l00028"></a>00028 {<a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="keyword">class </span>WSqlTable;<a name="l00031"></a>00031 <span class="keyword">class </span>WSqlDatabase;<a name="l00032"></a>00032 <a name="l00033"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html">00033</a> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_sql_driver.html" title="The WSqlDriver class is an abstract base class for database drivers.">WSqlDriver</a><a name="l00034"></a>00034 {<a name="l00035"></a>00035 <a name="l00036"></a>00036     <span class="keyword">public</span>:<a name="l00037"></a>00037         <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aafd8e66401bcbf3abe1abfa809979375" title="Construct a driver with the given database db.">WSqlDriver</a>( <a class="code" href="class_w_sql_1_1_w_sql_database.html" title="The WSqlDatabase class represents a single database.">WSqlDatabase</a> *db );<a name="l00038"></a>00038         <span class="keyword">virtual</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ad8c75e82dbe10f41eb7bd4e6a777e4d7" title="Destroys the driver and created resources.">~WSqlDriver</a>();<a name="l00039"></a>00039 <a name="l00040"></a>00040         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a2a1f251900715cd1e45aa7a565a57253">open</a>() = 0;<a name="l00041"></a>00041         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a17afc1e43627a2a952e76d04420dead0">close</a>() = 0;<a name="l00042"></a>00042         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ad15803a5c5d4e8e1d80fec885ed13203">query</a>(std::string sql) = 0;<a name="l00043"></a>00043         <span class="comment">//virtual bool execute(std::string sql) = 0;</span><a name="l00044"></a>00044         <span class="comment">// virtual WSqlResult exec(const WSqlQuery &amp;queryObject) = 0;</span><a name="l00045"></a>00045         <span class="keyword">virtual</span> std::vector&lt;std::string&gt; <a class="code" href="class_w_sql_1_1_w_sql_driver.html#adc7f0845587544ad92e3079542e844db">tableNames</a>() = 0;<a name="l00046"></a>00046         <span class="keyword">virtual</span> <a class="code" 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> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a2574f1f0d2083f1b0e05f4721f870a74">tableMetaData</a>( <span class="keyword">const</span> std::string &amp;tableName ) = 0;<a name="l00047"></a>00047                 <a name="l00048"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#ae5670416af2dc36911bc29478e5ad0e3">00048</a>         <span class="keyword">virtual</span> <a class="code" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a>* <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ae5670416af2dc36911bc29478e5ad0e3">result</a>(<span class="keywordtype">bool</span> iscached=<span class="keyword">true</span>){<span class="keywordflow">return</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a0fcc770ae53104549e68703eab08cab9">_result</a>;}<a name="l00049"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#aabd54e13ac3769bfd283cc8e7e937e6f">00049</a>         <span class="keyword">virtual</span> <a class="code" href="class_w_sql_1_1_w_sql_error.html" title="The WSqlError class provides SQL database and driver error information.">WSqlError</a> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aabd54e13ac3769bfd283cc8e7e937e6f">error</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _error;}<a name="l00050"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#aa81bf0a003e897f38574a8ee23348b8d">00050</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aa81bf0a003e897f38574a8ee23348b8d">isValid</a>()<span class="keyword">const </span>{ <span class="keywordflow">return</span> _isValid;}<a name="l00051"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a6c4bf314bfa0d19e476377891a949253">00051</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a6c4bf314bfa0d19e476377891a949253">isOpen</a>()<span class="keyword">const </span>{ <span class="keywordflow">return</span> _isOpen;}<a name="l00052"></a>00052         <a name="l00053"></a>00053         <a class="code" 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> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a26154ae9b11b139482be58c0b2ed4917" title="Locate the metadata table for tablename in the cache.">findTable</a>( std::string tablename )<span class="keyword">const</span>;<a name="l00054"></a>00054         <a name="l00055"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#aee4657eb1bf5d7d5b8a68dc51da1572f">00055</a>         <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aee4657eb1bf5d7d5b8a68dc51da1572f">hasError</a>()<span class="keyword">const </span>{ <span class="keywordflow">return</span> _hasError;}<a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="comment">//note: maybe auto disconnect/reconnect here?  or, do we even need this?              </span><a name="l00058"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#ae8e1c1685325f8c3fbab81992a0ff3de">00058</a>         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ae8e1c1685325f8c3fbab81992a0ff3de">setDatabase</a>( <a class="code" href="class_w_sql_1_1_w_sql_database.html" title="The WSqlDatabase class represents a single database.">WSqlDatabase</a> *dp ) { <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a6aac5abed866e56bd56ed20b7eef06f0">_database</a> = dp;}<a name="l00059"></a>00059 <a name="l00060"></a>00060     <span class="keyword">protected</span>:<a name="l00061"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#aec208bf350d9750fc15c0c908d7b989a">00061</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_sql_database.html" title="The WSqlDatabase class represents a single database.">WSqlDatabase</a>;<a name="l00062"></a>00062 <a name="l00063"></a>00063         <a class="code" 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>* <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ac8280245a9ab0d63d09c9b7b03c0b3b9" title="Return a reference to the metadata table for tablename in the cache.">getTable</a>( <span class="keyword">const</span> std::string&amp; tablename );<a name="l00064"></a>00064         <a name="l00065"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a18022bccc41d920564c83b02339aa4f8">00065</a>         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a18022bccc41d920564c83b02339aa4f8">setIsValid</a>( <span class="keywordtype">bool</span> b ) { _isValid = b;}<a name="l00066"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#adb8b4302e38822dbc2fbe71889ab7724">00066</a>         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#adb8b4302e38822dbc2fbe71889ab7724">setIsOpen</a>( <span class="keywordtype">bool</span> o ) { _isOpen = o;}<a name="l00067"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a76938d8fa49e562f015d7e6eb7b6ed42">00067</a>         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a76938d8fa49e562f015d7e6eb7b6ed42">setHasError</a>( <span class="keywordtype">bool</span> e ) { _hasError = e;}<a name="l00068"></a>00068         <a name="l00069"></a>00069         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aa5e7841c760ffc5c7dbc7c2593f8ecb3" title="Sets the the current error to error.">setError</a>(<span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_error.html" title="The WSqlError class provides SQL database and driver error information.">WSqlError</a>&amp; e );<a name="l00070"></a>00070         <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aa5e7841c760ffc5c7dbc7c2593f8ecb3" title="Sets the the current error to error.">setError</a>(<span class="keyword">const</span> std::string&amp; text,<a name="l00071"></a>00071                       <a class="code" href="class_w_sql_1_1_w_sql_error.html#a8bcabd8bf1016ca27304a717ef3d78db">WSqlError::ErrorType</a> type,<a name="l00072"></a>00072                       <a class="code" href="class_w_sql_1_1_w_sql_error.html#a63b2672eb5c68164c4ff43443037f6d9">WSqlError::ErrorSeverity</a> severity,<a name="l00073"></a>00073                       <span class="keywordtype">bool</span> isvalid = <span class="keyword">true</span> );<a name="l00074"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#ab1e89214bd9e0d8c9c0caaae52036287">00074</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#ab1e89214bd9e0d8c9c0caaae52036287">setError</a>(<span class="keyword">const</span> std::string&amp; text){<a name="l00075"></a>00075             <a class="code" href="class_w_sql_1_1_w_sql_driver.html#aa5e7841c760ffc5c7dbc7c2593f8ecb3" title="Sets the the current error to error.">setError</a>(text,<a class="code" href="class_w_sql_1_1_w_sql_error.html#a8bcabd8bf1016ca27304a717ef3d78dbaf8fb16501b5e83770c4bd3b33b19292c">WSql::WSqlError::DRIVER</a>, <a class="code" href="class_w_sql_1_1_w_sql_error.html#a63b2672eb5c68164c4ff43443037f6d9ab01b30be7fcbe01c43222c1b88e7727d">WSql::WSqlError::WARNING</a>);<a name="l00076"></a>00076         }<a name="l00077"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a334d7b76b1bf64c4d779b0196510faac">00077</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a334d7b76b1bf64c4d779b0196510faac">setError</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * text){<a class="code" href="class_w_sql_1_1_w_sql_driver.html#a334d7b76b1bf64c4d779b0196510faac">setError</a>(std::string(text));}<a name="l00078"></a>00078         <a name="l00079"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a6aac5abed866e56bd56ed20b7eef06f0">00079</a>         <a class="code" href="class_w_sql_1_1_w_sql_database.html" title="The WSqlDatabase class represents a single database.">WSqlDatabase</a> *<a class="code" href="class_w_sql_1_1_w_sql_driver.html#a6aac5abed866e56bd56ed20b7eef06f0">_database</a>;<a name="l00080"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a0fcc770ae53104549e68703eab08cab9">00080</a>         <a class="code" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a> * <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a0fcc770ae53104549e68703eab08cab9">_result</a>;<a name="l00081"></a><a class="code" href="class_w_sql_1_1_w_sql_driver.html#a4eae8e8af5b50b1bc3a10bf528073724">00081</a>         std::vector&lt;WSqlTable&gt; <a class="code" href="class_w_sql_1_1_w_sql_driver.html#a4eae8e8af5b50b1bc3a10bf528073724">_tables</a>;<a name="l00082"></a>00082         <a name="l00083"></a>00083     <span class="keyword">private</span>:<a name="l00084"></a>00084         <span class="keywordtype">bool</span> _isValid;<a name="l00085"></a>00085         <span class="keywordtype">bool</span> _isOpen;<a name="l00086"></a>00086         <span class="keywordtype">bool</span> _hasError;<a name="l00087"></a>00087         std::string _databaseName;<a name="l00088"></a>00088         <a class="code" href="class_w_sql_1_1_w_sql_error.html" title="The WSqlError class provides SQL database and driver error information.">WSqlError</a> _error;<a name="l00089"></a>00089         std::vector&lt;WSqlError&gt; _errors;<a name="l00090"></a>00090 };<a name="l00091"></a>00091 <a name="l00092"></a>00092 } <span class="comment">// namespace WSql</span><a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="preprocessor">#endif // WSQLDRIVER_H</span></pre></div></div></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:45 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>