CL-Softwares
/
Nut
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Nut/doc/html/class_query.html

195 lines
12 KiB
HTML
Raw Blame History

<!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"/>
<title>Nut: Query&lt; T &gt; Class Template Reference</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="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">Nut
&#160;<span id="projectnumber">0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</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>
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_query-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Query&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class hold a query.
<a href="class_query.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ababbcc4e9b15efcef172bd487ed53c55"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ababbcc4e9b15efcef172bd487ed53c55"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Query</b> (<a class="el" href="class_database.html">Database</a> *database, TableSetBase *tableSet)</td></tr>
<tr class="memitem:a6c939f50425b98cc3e0d3df9e155d302"><td class="memItemLeft" align="right" valign="top">QList&lt; T * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_query.html#a6c939f50425b98cc3e0d3df9e155d302">toList</a> (int count=-1)</td></tr>
<tr class="memitem:a6fed62d17dba15dc90a06066b1cee249"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fed62d17dba15dc90a06066b1cee249"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>remove</b> ()</td></tr>
<tr class="memitem:a9e50d18451c26f1d3ac71f038286e30c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e50d18451c26f1d3ac71f038286e30c"></a>
T *&#160;</td><td class="memItemRight" valign="bottom"><b>first</b> ()</td></tr>
<tr class="memitem:a9d99c48661030c13aa5caa6b32990e67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d99c48661030c13aa5caa6b32990e67"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>count</b> ()</td></tr>
<tr class="memitem:afbb31681d5cd046714c7a101c7725b87"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbb31681d5cd046714c7a101c7725b87"></a>
QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>max</b> (<a class="el" href="class_field_phrase.html">FieldPhrase</a> &amp;f)</td></tr>
<tr class="memitem:ae0b0a3f6da34f6000a4e4ee09e3590b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0b0a3f6da34f6000a4e4ee09e3590b1"></a>
QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>min</b> (<a class="el" href="class_field_phrase.html">FieldPhrase</a> &amp;f)</td></tr>
<tr class="memitem:a079c9677a43ba1f90150bebc27e71e78"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a079c9677a43ba1f90150bebc27e71e78"></a>
QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>average</b> (<a class="el" href="class_field_phrase.html">FieldPhrase</a> &amp;f)</td></tr>
<tr class="memitem:ac9addf958f4e2ffb885de400c56a05e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9addf958f4e2ffb885de400c56a05e1"></a>
<a class="el" href="class_query.html">Query</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>join</b> (const QString &amp;tableName)</td></tr>
<tr class="memitem:ab4be37c2a469cbd549b7df9e5f415599"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_query.html">Query</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_query.html#ab4be37c2a469cbd549b7df9e5f415599">setWhere</a> (<a class="el" href="class_where_phrase.html">WherePhrase</a> where)</td></tr>
<tr class="memdesc:ab4be37c2a469cbd549b7df9e5f415599"><td class="mdescLeft">&#160;</td><td class="mdescRight">Where phrase is a phrase using table's static field methods. <a href="#ab4be37c2a469cbd549b7df9e5f415599"></a><br/></td></tr>
<tr class="memitem:adae00338750aeadf3efceaa184d61b2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adae00338750aeadf3efceaa184d61b2e"></a>
<a class="el" href="class_query.html">Query</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>join</b> (<a class="el" href="class_table.html">Table</a> *c)</td></tr>
<tr class="memitem:a43cfc4faf57c3e686eba49a82b5a1536"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43cfc4faf57c3e686eba49a82b5a1536"></a>
<a class="el" href="class_query.html">Query</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>orderBy</b> (QString fieldName, QString type)</td></tr>
<tr class="memitem:aa06b66cc9bbe9f3901215c943b94bb89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_query.html">Query</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_query.html#aa06b66cc9bbe9f3901215c943b94bb89">orderBy</a> (<a class="el" href="class_where_phrase.html">WherePhrase</a> phrase)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br/>
class Query&lt; T &gt;</h3>
<p>This class hold a query. </p>
<p>A query can be used for getting database rows, editing or deleting without row fetching. A query can be used for getting data from database. </p>
<div class="fragment"><div class="line"><span class="keyword">auto</span> q = db.posts()-&gt;createQuery();</div>
<div class="line">q-&gt;join(Post::commentsTable());</div>
<div class="line">q-&gt;orderBy(!Post::saveDateField() &amp; Post::bodyField());</div>
<div class="line">q-&gt;setWhere(Post::idField() &gt; 5);</div>
<div class="line"></div>
<div class="line"><span class="keyword">auto</span> posts = q-&gt;toList();</div>
</div><!-- fragment --><p> In below code posts is a QList&lt;Post&gt; that contain rows from database from this query: </p>
<div class="fragment"><div class="line">SELECT * FROM post WHERE post.id&gt;5 ORDER BY post.saveDate DESC, post.body</div>
</div><!-- fragment --> </div><h2>Member Function Documentation</h2>
<a class="anchor" id="aa06b66cc9bbe9f3901215c943b94bb89"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">Q_OUTOFLINE_TEMPLATE <a class="el" href="class_query.html">Query</a>&lt; T &gt; * <a class="el" href="class_query.html">Query</a>&lt; T &gt;::orderBy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_where_phrase.html">WherePhrase</a>&#160;</td>
<td class="paramname"><em>phrase</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">phrase</td><td>Order phrase </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function return class itself orderBy set a new order for this query. Order can be a hrase like that: <div class="fragment"><div class="line">query-&gt;orderBy(Post::idField());</div>
</div><!-- fragment --> If you need more than one order field seprate them by &amp; operator, example: <div class="fragment"><div class="line">query-&gt;orderBy(Post::idField() &amp; Post::bodyField());</div>
</div><!-- fragment --> Order can be also DESC, for that put exclamation mark near field <div class="fragment"><div class="line">query-&gt;orderBy(!Post::idField &amp; Post::bodyField());</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a class="anchor" id="ab4be37c2a469cbd549b7df9e5f415599"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">Q_OUTOFLINE_TEMPLATE <a class="el" href="class_query.html">Query</a>&lt; T &gt; * <a class="el" href="class_query.html">Query</a>&lt; T &gt;::setWhere </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_where_phrase.html">WherePhrase</a>&#160;</td>
<td class="paramname"><em>where</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Where phrase is a phrase using table's static field methods. </p>
<div class="fragment"><div class="line">q-&gt;setWhere(Post::idField() == 4 || Post::titleField().isNull());</div>
</div><!-- fragment --><p> In sql this is like below code: </p>
<div class="fragment"><div class="line">... WHERE post.id=4 OR post.title IS NULL</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>Where phrase </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function return class itself </dd></dl>
</div>
</div>
<a class="anchor" id="a6c939f50425b98cc3e0d3df9e155d302"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="memname">
<tr>
<td class="memname">Q_OUTOFLINE_TEMPLATE QList&lt; T * &gt; <a class="el" href="class_query.html">Query</a>&lt; T &gt;::toList </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>count</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>Total rows must be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function return class itself This function return rows </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="query_8h_source.html">query.h</a></li>
<li>src/query.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 5 2016 17:37:29 for Nut by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink