http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html new file mode 100644 index 0000000..d51bd83 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ConstraintInfo.html @@ -0,0 +1,146 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::ConstraintInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1ConstraintInfo.html">ConstraintInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::ConstraintInfo Class Reference</h1><!-- doxytag: class="tmudr::ConstraintInfo" --><!-- doxytag: inherits="tmudr::TMUDRSerializableObject" --> +<p>A constraint on a table-valued input or output table. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for tmudr::ConstraintInfo:</div> +<div class="dynsection"> + <div class="center"> + <img src="classtmudr_1_1ConstraintInfo.gif" usemap="#tmudr::ConstraintInfo_map" alt=""/> + <map id="tmudr::ConstraintInfo_map" name="tmudr::ConstraintInfo_map"> +<area href="classtmudr_1_1CardinalityConstraintInfo.html" alt="tmudr::CardinalityConstraintInfo" shape="rect" coords="0,56,188,80"/> +<area href="classtmudr_1_1UniqueConstraintInfo.html" alt="tmudr::UniqueConstraintInfo" shape="rect" coords="198,56,386,80"/> +</map> + </div> +</div> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029">ConstraintTypeCode</a> { <a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029afb46759b2d515c81e6e10a7a687432e4">CARDINALITY</a>, +<a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029a17d366cd7f84a5f9a69a6419309006f9">UNIQUE</a> + }</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029">ConstraintTypeCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ConstraintInfo.html#a334f7ca84835a0cb158a83e0d033b177">getType</a> () const </td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>A constraint on a table-valued input or output table. </p> +<p>This could be a uniqueness constraint, a cardinality constraint or some other constraint </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a10e620641613b68ca5a9c063f3ed5029"></a><!-- doxytag: member="tmudr::ConstraintInfo::ConstraintTypeCode" ref="a10e620641613b68ca5a9c063f3ed5029" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029">tmudr::ConstraintInfo::ConstraintTypeCode</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Type of a constraint </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a10e620641613b68ca5a9c063f3ed5029afb46759b2d515c81e6e10a7a687432e4"></a><!-- doxytag: member="CARDINALITY" ref="a10e620641613b68ca5a9c063f3ed5029afb46759b2d515c81e6e10a7a687432e4" args="" -->CARDINALITY</em> </td><td> +<p>Cardinality constraint. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a10e620641613b68ca5a9c063f3ed5029a17d366cd7f84a5f9a69a6419309006f9"></a><!-- doxytag: member="UNIQUE" ref="a10e620641613b68ca5a9c063f3ed5029a17d366cd7f84a5f9a69a6419309006f9" args="" -->UNIQUE</em> </td><td> +<p>Uniqueness constraint. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a334f7ca84835a0cb158a83e0d033b177"></a><!-- doxytag: member="tmudr::ConstraintInfo::getType" ref="a334f7ca84835a0cb158a83e0d033b177" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classtmudr_1_1ConstraintInfo.html#a10e620641613b68ca5a9c063f3ed5029">ConstraintInfo::ConstraintTypeCode</a> ConstraintInfo::getType </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the type of the constraint.</p> +<p>This allows safe casting to derived classes, based on the type.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Type of the constraint. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html new file mode 100644 index 0000000..82df825 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1OrderInfo.html @@ -0,0 +1,318 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::OrderInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1OrderInfo.html">OrderInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::OrderInfo Class Reference</h1><!-- doxytag: class="tmudr::OrderInfo" --> +<p>Ordering of a table by some ascending or descending columns. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> { <a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664ca6d13be11b628da60b716cbe1defdefcc">NO_ORDER</a>, +<a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664ca9f5d23e242952104222576f9ab331ad4">ASCENDING</a>, +<a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664ca4b7811d9e06b5befccfb56ef27fee64b">DESCENDING</a> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Ascending/descending order of columns. </p> + <a href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">More...</a><br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#a98f1be7578ab034d00919d3f8b5ac037">getNumEntries</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#ad2ce0a427824990fb577c99465307667">getColumnNum</a> (int i) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#acffea7ba665daca1bf67b15ca62c7a18">getOrderType</a> (int i) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#a5b74383fb58f2003fcbab8daaf69194a">addEntry</a> (int colNum, <a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> orderType=ASCENDING)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#a672fd00b856f225c189de7adce65cf30">addEntryAt</a> (int pos, int colNum, <a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> orderType=ASCENDING)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1OrderInfo.html#aceceec297c0709e19003dec60f149305">clear</a> ()</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Ordering of a table by some ascending or descending columns. </p> +<p>A list of columns, represented by column numbers, with an ascending/descending indicator for each column. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a6dc71ab80df38d3c3fe0d060ac03664c"></a><!-- doxytag: member="tmudr::OrderInfo::OrderTypeCode" ref="a6dc71ab80df38d3c3fe0d060ac03664c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">tmudr::OrderInfo::OrderTypeCode</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Ascending/descending order of columns. </p> +<p>For outputs, the ordering of values from the first row out to the last. Note that this ordering applies within a parallel instance of the UDF at runtime, but it does not guarantee a total order. For example, two parallel instances may get these ordered values: instance 0 gets 1,3,5,7 instance 1 gets 2,4,6,8 </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a6dc71ab80df38d3c3fe0d060ac03664ca6d13be11b628da60b716cbe1defdefcc"></a><!-- doxytag: member="NO_ORDER" ref="a6dc71ab80df38d3c3fe0d060ac03664ca6d13be11b628da60b716cbe1defdefcc" args="" -->NO_ORDER</em> </td><td> +<p>Unspecified order. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a6dc71ab80df38d3c3fe0d060ac03664ca9f5d23e242952104222576f9ab331ad4"></a><!-- doxytag: member="ASCENDING" ref="a6dc71ab80df38d3c3fe0d060ac03664ca9f5d23e242952104222576f9ab331ad4" args="" -->ASCENDING</em> </td><td> +<p>Ascending order. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a6dc71ab80df38d3c3fe0d060ac03664ca4b7811d9e06b5befccfb56ef27fee64b"></a><!-- doxytag: member="DESCENDING" ref="a6dc71ab80df38d3c3fe0d060ac03664ca4b7811d9e06b5befccfb56ef27fee64b" args="" -->DESCENDING</em> </td><td> +<p>Descending order. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a5b74383fb58f2003fcbab8daaf69194a"></a><!-- doxytag: member="tmudr::OrderInfo::addEntry" ref="a5b74383fb58f2003fcbab8daaf69194a" args="(int colNum, OrderTypeCode orderType=ASCENDING)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void OrderInfo::addEntry </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>colNum</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> </td> + <td class="paramname"> <em>orderType</em> = <code>ASCENDING</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Append an entry to the ordering.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>colNum</em> </td><td>Column number to append to the ordering. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>orderType</em> </td><td>Order type (ascending or descending) to use. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a672fd00b856f225c189de7adce65cf30"></a><!-- doxytag: member="tmudr::OrderInfo::addEntryAt" ref="a672fd00b856f225c189de7adce65cf30" args="(int pos, int colNum, OrderTypeCode orderType=ASCENDING)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void OrderInfo::addEntryAt </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>colNum</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderTypeCode</a> </td> + <td class="paramname"> <em>orderType</em> = <code>ASCENDING</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Insert an entry at any position of the ordering.</p> +<p>A quick example to illustrate this: Let's say we have a table with columns (a,b,c). Their column numbers are 0, 1, and 2. We produce an ordering (C ASCENDING):</p> +<div class="fragment"><pre class="fragment"> OrderInfo myorder; + + myorder.addEntryAt(0, 2); +</pre></div><p>Next, we want to make this into (B DESCENDING, C ASCENDING):</p> +<div class="fragment"><pre class="fragment"> myorder.addEntryAt(0, 1, <a class="code" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664ca4b7811d9e06b5befccfb56ef27fee64b" title="Descending order.">DESCENDING</a>); +</pre></div><dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>Position (0-based) at which we want to insert. The new entry will be position "pos" after the insertion, any existing entries will be moved up. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>colNum</em> </td><td>Number of the column by which we want to order </td></tr> + <tr><td valign="top"></td><td valign="top"><em>orderType</em> </td><td>Order type (ascending or descending) to use </td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aceceec297c0709e19003dec60f149305"></a><!-- doxytag: member="tmudr::OrderInfo::clear" ref="aceceec297c0709e19003dec60f149305" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void OrderInfo::clear </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Clear the contents of the object </p> + +</div> +</div> +<a class="anchor" id="ad2ce0a427824990fb577c99465307667"></a><!-- doxytag: member="tmudr::OrderInfo::getColumnNum" ref="ad2ce0a427824990fb577c99465307667" args="(int i) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int OrderInfo::getColumnNum </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>i</em></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the column number of an entry of the ordering.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the position (0-based) of the ordering, 0 meaning the leading position. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The column number of the n-th entry of the ordering (both are 0-based). </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a98f1be7578ab034d00919d3f8b5ac037"></a><!-- doxytag: member="tmudr::OrderInfo::getNumEntries" ref="a98f1be7578ab034d00919d3f8b5ac037" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int OrderInfo::getNumEntries </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the number of entries (columns) in the ordering.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Number of entries/columns that make up the ordering. </dd></dl> + +</div> +</div> +<a class="anchor" id="acffea7ba665daca1bf67b15ca62c7a18"></a><!-- doxytag: member="tmudr::OrderInfo::getOrderType" ref="acffea7ba665daca1bf67b15ca62c7a18" args="(int i) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classtmudr_1_1OrderInfo.html#a6dc71ab80df38d3c3fe0d060ac03664c">OrderInfo::OrderTypeCode</a> OrderInfo::getOrderType </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>i</em></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the order type of an entry of the ordering.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the position (0-based) of the ordering, 0 meaning the leading position. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The order type of the n-th entry of the ordering (0-based). </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif new file mode 100644 index 0000000..a2426a2 Binary files /dev/null and b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html new file mode 100644 index 0000000..7a7a009 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ParameterListInfo.html @@ -0,0 +1,94 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::ParameterListInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1ParameterListInfo.html">ParameterListInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::ParameterListInfo Class Reference</h1><!-- doxytag: class="tmudr::ParameterListInfo" --><!-- doxytag: inherits="tmudr::TupleInfo" --> +<p>Describes the parameters of a <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a>. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for tmudr::ParameterListInfo:</div> +<div class="dynsection"> + <div class="center"> + <img src="classtmudr_1_1ParameterListInfo.gif" usemap="#tmudr::ParameterListInfo_map" alt=""/> + <map id="tmudr::ParameterListInfo_map" name="tmudr::ParameterListInfo_map"> +<area href="classtmudr_1_1TupleInfo.html" alt="tmudr::TupleInfo" shape="rect" coords="0,0,147,24"/> +</map> + </div> +</div> +<table border="0" cellpadding="0" cellspacing="0"> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Describes the parameters of a <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a>. </p> +<p>This method currently has no methods relevant to the <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a> writer, but the base class, <a class="el" href="classtmudr_1_1TupleInfo.html" title="Common base class for parameter lists and row layouts.">TupleInfo</a>, has a variety of methods.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classtmudr_1_1TupleInfo.html" title="Common base class for parameter lists and row layouts.">TupleInfo</a> </dd></dl> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html new file mode 100644 index 0000000..c0cacba --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PartitionInfo.html @@ -0,0 +1,296 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::PartitionInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1PartitionInfo.html">PartitionInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::PartitionInfo Class Reference</h1><!-- doxytag: class="tmudr::PartitionInfo" --> +<p>Partitioning key of an input table or result table. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">PartitionTypeCode</a> { <br/> + <a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47a8a99eef243aad98789ee3baf4cb19256">UNKNOWN</a>, +<a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47a30b6fa8e98526ba1e69dc2bf79cbcb67">ANY</a>, +<a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47ac2f6cb09339e246ac6cab9c134303936">SERIAL</a>, +<a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47ae906e2c99d706593c99cbfbe4a611714">PARTITION</a>, +<br/> + <a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47a5538c1623f9dcbaa55d17eb64d3050c4">REPLICATE</a> +<br/> + }</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#ae1411139831696fa77091527bd84aaed">PartitionInfo</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">PartitionTypeCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a6ecd4b61fd57efd8266b27015bb7aef6">getType</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a429004207edd57047104326d88d81e99">getNumEntries</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a41154eead77fd72a178778feaa560424">getColumnNum</a> (int i) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a26c772d4aa4e4531bf4bd702f80e3d96">setType</a> (<a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">PartitionTypeCode</a> type)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#aa6f04c586f8f76c9213507c4c76d9500">addEntry</a> (int colNum)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PartitionInfo.html#a27f3f1be7211f858211aad76e0f13604">clear</a> ()</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Partitioning key of an input table or result table. </p> +<p>Describes the partitioning key of a table-valued input or result. When executing a <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a> in parallel, if a table is partitioned on some columns, e.g. (a,b), this means that a rows with particular values for (a,b), e.g. (10, 20) will all go to the same parallel instance and will be seen as a contiguous group. This is similar to the key of a reducer in MapReduce, except that in this case we process a group of rows with the same key, not a single key and a list of values. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47"></a><!-- doxytag: member="tmudr::PartitionInfo::PartitionTypeCode" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">tmudr::PartitionInfo::PartitionTypeCode</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Type of partitioning </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47a8a99eef243aad98789ee3baf4cb19256"></a><!-- doxytag: member="UNKNOWN" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47a8a99eef243aad98789ee3baf4cb19256" args="" -->UNKNOWN</em> </td><td> +<p>Partitioning type not yet determined. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47a30b6fa8e98526ba1e69dc2bf79cbcb67"></a><!-- doxytag: member="ANY" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47a30b6fa8e98526ba1e69dc2bf79cbcb67" args="" -->ANY</em> </td><td> +<p>No limitations on parallel execution, typical for mappers, any row can be evaluated by any parallel instance of the UDF. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47ac2f6cb09339e246ac6cab9c134303936"></a><!-- doxytag: member="SERIAL" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47ac2f6cb09339e246ac6cab9c134303936" args="" -->SERIAL</em> </td><td> +<p>No partitioning is allowed, execute serially in a single instance. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47ae906e2c99d706593c99cbfbe4a611714"></a><!-- doxytag: member="PARTITION" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47ae906e2c99d706593c99cbfbe4a611714" args="" -->PARTITION</em> </td><td> +<p>Allow parallelism with partitioning key, if specified, serial execution otherwise. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a00d9199b7b9ded5c9f6c2d2aadf16e47a5538c1623f9dcbaa55d17eb64d3050c4"></a><!-- doxytag: member="REPLICATE" ref="a00d9199b7b9ded5c9f6c2d2aadf16e47a5538c1623f9dcbaa55d17eb64d3050c4" args="" -->REPLICATE</em> </td><td> +<p>Replicate the data to each parallel instance. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ae1411139831696fa77091527bd84aaed"></a><!-- doxytag: member="tmudr::PartitionInfo::PartitionInfo" ref="ae1411139831696fa77091527bd84aaed" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PartitionInfo::PartitionInfo </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Default constructor</p> +<p>Use this constructor to generate an object to be passed to <a class="el" href="classtmudr_1_1UDRInvocationInfo.html#ac2e13c982996e5e32f67cd157efce2fd">UDRInvocationInfo::setChildPartitioning()</a>. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aa6f04c586f8f76c9213507c4c76d9500"></a><!-- doxytag: member="tmudr::PartitionInfo::addEntry" ref="aa6f04c586f8f76c9213507c4c76d9500" args="(int colNum)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PartitionInfo::addEntry </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>colNum</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Add a new column to the list of partitioning columns</p> +<p>Add a new column to the list of column numbers that form the partitioning key. Use this only if the type of the partitioning is set to PARTITION.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>colNum</em> </td><td>Number of the column (ordinal, 0-based) of the associated table. </td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a27f3f1be7211f858211aad76e0f13604"></a><!-- doxytag: member="tmudr::PartitionInfo::clear" ref="a27f3f1be7211f858211aad76e0f13604" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PartitionInfo::clear </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Clear the contents of the object </p> + +</div> +</div> +<a class="anchor" id="a41154eead77fd72a178778feaa560424"></a><!-- doxytag: member="tmudr::PartitionInfo::getColumnNum" ref="a41154eead77fd72a178778feaa560424" args="(int i) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int PartitionInfo::getColumnNum </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>i</em></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the number/ordinal of the ith partitioning column.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Number/ordinal (0-based) of the ith partitioning column in the list of partitioning columns. </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a429004207edd57047104326d88d81e99"></a><!-- doxytag: member="tmudr::PartitionInfo::getNumEntries" ref="a429004207edd57047104326d88d81e99" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int PartitionInfo::getNumEntries </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the number of columns that form the partitioning key</p> +<p>Returns the number of columns in the list of partitioning keys or zero if there are no such columns.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Number of partitioning key columns (could be zero) </dd></dl> + +</div> +</div> +<a class="anchor" id="a6ecd4b61fd57efd8266b27015bb7aef6"></a><!-- doxytag: member="tmudr::PartitionInfo::getType" ref="a6ecd4b61fd57efd8266b27015bb7aef6" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">PartitionInfo::PartitionTypeCode</a> PartitionInfo::getType </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the partitioning type.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Partition type enum. </dd></dl> + +</div> +</div> +<a class="anchor" id="a26c772d4aa4e4531bf4bd702f80e3d96"></a><!-- doxytag: member="tmudr::PartitionInfo::setType" ref="a26c772d4aa4e4531bf4bd702f80e3d96" args="(PartitionTypeCode type)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PartitionInfo::setType </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classtmudr_1_1PartitionInfo.html#a00d9199b7b9ded5c9f6c2d2aadf16e47">PartitionTypeCode</a> </td> + <td class="paramname"> <em>type</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Set the partitioning type.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Partition type enum. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif new file mode 100644 index 0000000..c8c90bb Binary files /dev/null and b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html new file mode 100644 index 0000000..ee6e267 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1PredicateInfo.html @@ -0,0 +1,268 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::PredicateInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1PredicateInfo.html">PredicateInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::PredicateInfo Class Reference</h1><!-- doxytag: class="tmudr::PredicateInfo" --><!-- doxytag: inherits="tmudr::TMUDRSerializableObject" --> +<p>A predicate to be evaluated on a table. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for tmudr::PredicateInfo:</div> +<div class="dynsection"> + <div class="center"> + <img src="classtmudr_1_1PredicateInfo.gif" usemap="#tmudr::PredicateInfo_map" alt=""/> + <map id="tmudr::PredicateInfo_map" name="tmudr::PredicateInfo_map"> +<area href="classtmudr_1_1ComparisonPredicateInfo.html" alt="tmudr::ComparisonPredicateInfo" shape="rect" coords="0,56,191,80"/> +</map> + </div> +</div> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232">EvaluationCode</a> { <a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232a9a9d393cf0eee2d3f06d72ff09922ed5">UNKNOWN_EVAL</a> = 0, +<a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232aaa9bf12167c7575208c449d059c957b2">EVALUATE_ON_RESULT</a> = 0x1, +<a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232a166c3ebfedcb9c566daf6a114da8c15f">EVALUATE_IN_UDF</a> = 0x2, +<a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232ac9e7ffa3c75fe7571cf22a1d8c33301b">EVALUATE_IN_CHILD</a> = 0x4 + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Info on whether a table-valued input or output column is used. </p> + <a href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5">PredOperator</a> { <br/> + <a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5acc2e2fe0b00dd8f64160e946a68db97b">UNKNOWN_OP</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5aa74af3680d17b0a31a5aeb71132e22a8">EQUAL</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5a50262f568344c15cc0d3ac289e91523f">NOT_EQUAL</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5aef604ed2edbce4fe1605c93f8f1cf8b4">LESS</a>, +<br/> + <a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5ab1330d4ccc7637cb80d672e28cff95a6">LESS_EQUAL</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5a7c978537b911c81d78f3db4a91a012c7">GREATER</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5a5efc4c3d6b386d347ae3af5946e240e9">GREATER_EQUAL</a>, +<a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5a93914d26fbbf66d58952c891a94ccf59">IN</a>, +<br/> + <a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5ad3393b6e03346f32766ddcad5de5eed9">NOT_IN</a> +<br/> + }</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232">EvaluationCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PredicateInfo.html#aa2ef2035fddfe7375d8fecaae94528c9">getEvaluationCode</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5">PredOperator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PredicateInfo.html#aaaae2bb25f6c7e95cf74666649e615b2">getOperator</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1PredicateInfo.html#aff4280afceebaa23faf6804748d1c719">isAComparisonPredicate</a> () const </td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>A predicate to be evaluated on a table. </p> +<p>These could be different kinds of predicates, like an equals predicate, a non-equals predicate or more complex cases. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="aa2a53f51db2e8e56cf79fe8c28e54232"></a><!-- doxytag: member="tmudr::PredicateInfo::EvaluationCode" ref="aa2a53f51db2e8e56cf79fe8c28e54232" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232">tmudr::PredicateInfo::EvaluationCode</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Info on whether a table-valued input or output column is used. </p> +<p>Note that these are not necessarily exclusive, a predicate might be evaluated in multiple places, although that should not be common and is not yet allowed. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="aa2a53f51db2e8e56cf79fe8c28e54232a9a9d393cf0eee2d3f06d72ff09922ed5"></a><!-- doxytag: member="UNKNOWN_EVAL" ref="aa2a53f51db2e8e56cf79fe8c28e54232a9a9d393cf0eee2d3f06d72ff09922ed5" args="" -->UNKNOWN_EVAL</em> </td><td> +<p>Not yet determined where predicate is evaluated. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aa2a53f51db2e8e56cf79fe8c28e54232aaa9bf12167c7575208c449d059c957b2"></a><!-- doxytag: member="EVALUATE_ON_RESULT" ref="aa2a53f51db2e8e56cf79fe8c28e54232aaa9bf12167c7575208c449d059c957b2" args="" -->EVALUATE_ON_RESULT</em> </td><td> +<p>Predicate is evaluated on the UDF result, in Trafodion code. This is the default. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aa2a53f51db2e8e56cf79fe8c28e54232a166c3ebfedcb9c566daf6a114da8c15f"></a><!-- doxytag: member="EVALUATE_IN_UDF" ref="aa2a53f51db2e8e56cf79fe8c28e54232a166c3ebfedcb9c566daf6a114da8c15f" args="" -->EVALUATE_IN_UDF</em> </td><td> +<p>Predicate is evaluated inside the code provided by the <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a> writer. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aa2a53f51db2e8e56cf79fe8c28e54232ac9e7ffa3c75fe7571cf22a1d8c33301b"></a><!-- doxytag: member="EVALUATE_IN_CHILD" ref="aa2a53f51db2e8e56cf79fe8c28e54232ac9e7ffa3c75fe7571cf22a1d8c33301b" args="" -->EVALUATE_IN_CHILD</em> </td><td> +<p>Predicate should be evaluated in a table-valued input before the data reaches the UDF. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5"></a><!-- doxytag: member="tmudr::PredicateInfo::PredOperator" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5">tmudr::PredicateInfo::PredOperator</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Operator of a relational (comparison) predicate </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5acc2e2fe0b00dd8f64160e946a68db97b"></a><!-- doxytag: member="UNKNOWN_OP" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5acc2e2fe0b00dd8f64160e946a68db97b" args="" -->UNKNOWN_OP</em> </td><td> +<p>Operator not yet determined. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5aa74af3680d17b0a31a5aeb71132e22a8"></a><!-- doxytag: member="EQUAL" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5aa74af3680d17b0a31a5aeb71132e22a8" args="" -->EQUAL</em> </td><td> +<p>Equals predicate (col = val). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5a50262f568344c15cc0d3ac289e91523f"></a><!-- doxytag: member="NOT_EQUAL" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5a50262f568344c15cc0d3ac289e91523f" args="" -->NOT_EQUAL</em> </td><td> +<p>Not equals predicate (col <> val). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5aef604ed2edbce4fe1605c93f8f1cf8b4"></a><!-- doxytag: member="LESS" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5aef604ed2edbce4fe1605c93f8f1cf8b4" args="" -->LESS</em> </td><td> +<p>Less than predicate (col <). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5ab1330d4ccc7637cb80d672e28cff95a6"></a><!-- doxytag: member="LESS_EQUAL" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5ab1330d4ccc7637cb80d672e28cff95a6" args="" -->LESS_EQUAL</em> </td><td> +<p>Less or equals predicate (col <=). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5a7c978537b911c81d78f3db4a91a012c7"></a><!-- doxytag: member="GREATER" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5a7c978537b911c81d78f3db4a91a012c7" args="" -->GREATER</em> </td><td> +<p>Greater predicate (col >). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5a5efc4c3d6b386d347ae3af5946e240e9"></a><!-- doxytag: member="GREATER_EQUAL" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5a5efc4c3d6b386d347ae3af5946e240e9" args="" -->GREATER_EQUAL</em> </td><td> +<p>Greater or equals predicate (col >=). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5a93914d26fbbf66d58952c891a94ccf59"></a><!-- doxytag: member="IN" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5a93914d26fbbf66d58952c891a94ccf59" args="" -->IN</em> </td><td> +<p>IN predicate (col IN). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="ab22c05aab4b2ec61421fc2d9efa9f2b5ad3393b6e03346f32766ddcad5de5eed9"></a><!-- doxytag: member="NOT_IN" ref="ab22c05aab4b2ec61421fc2d9efa9f2b5ad3393b6e03346f32766ddcad5de5eed9" args="" -->NOT_IN</em> </td><td> +<p>NOT IN predicate (col NOT IN). </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aa2ef2035fddfe7375d8fecaae94528c9"></a><!-- doxytag: member="tmudr::PredicateInfo::getEvaluationCode" ref="aa2ef2035fddfe7375d8fecaae94528c9" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classtmudr_1_1PredicateInfo.html#aa2a53f51db2e8e56cf79fe8c28e54232">PredicateInfo::EvaluationCode</a> PredicateInfo::getEvaluationCode </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get evaluation code for a predicate.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Evaluation code. </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aaaae2bb25f6c7e95cf74666649e615b2"></a><!-- doxytag: member="tmudr::PredicateInfo::getOperator" ref="aaaae2bb25f6c7e95cf74666649e615b2" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classtmudr_1_1PredicateInfo.html#ab22c05aab4b2ec61421fc2d9efa9f2b5">PredicateInfo::PredOperator</a> PredicateInfo::getOperator </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get operator code for a predicate.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Operator code. </dd></dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aff4280afceebaa23faf6804748d1c719"></a><!-- doxytag: member="tmudr::PredicateInfo::isAComparisonPredicate" ref="aff4280afceebaa23faf6804748d1c719" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PredicateInfo::isAComparisonPredicate </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Check whether this predicate is a comparison predicate.</p> +<p>Use this method to determine whether it is safe to cast the object to class <a class="el" href="classtmudr_1_1ComparisonPredicateInfo.html" title="A comparison predicate to be evaluated on a table.">ComparisonPredicateInfo</a>.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if predcate i is a comparison predicate, false otherwise. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ProvenanceInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ProvenanceInfo.html b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ProvenanceInfo.html new file mode 100644 index 0000000..2c9f991 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1ProvenanceInfo.html @@ -0,0 +1,214 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>tmudr: tmudr::ProvenanceInfo 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.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.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)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1ProvenanceInfo.html">ProvenanceInfo</a> + </div> +</div> +<div class="contents"> +<h1>tmudr::ProvenanceInfo Class Reference</h1><!-- doxytag: class="tmudr::ProvenanceInfo" --> +<p>Describes where an output column is coming from. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ProvenanceInfo.html#ad6be4c301a7f3b9a34d2c0863fa3d337">ProvenanceInfo</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ProvenanceInfo.html#afe9e921ca4bbbe70f2ad1cdbc27618b5">ProvenanceInfo</a> (int inputTableNum, int inputColNum)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ProvenanceInfo.html#adfad1a87e41077dc3dd62ca4e073b3ef">getInputTableNum</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ProvenanceInfo.html#a2c10c9b580e812db85cf7c74a35f63c2">getInputColumnNum</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1ProvenanceInfo.html#ad8d8d8c7b33c849000f0fd33e9d6c797">isFromInputTable</a> (int inputTableNum=-1) const </td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Describes where an output column is coming from. </p> +<p>Points to input table and input column number that is the source of a column. This must only be used if the result column always has the exact same value as the current value of the corresponding input column.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classtmudr_1_1ColumnInfo.html#abd56e48603e02a2b65f383921a2c44a1">ColumnInfo::getProvenance()</a> </dd> +<dd> +<a class="el" href="classtmudr_1_1ColumnInfo.html#a361ed635eeb56e2262a41aded487ccf7">ColumnInfo::setProvenance()</a> </dd> +<dd> +<a class="el" href="classtmudr_1_1UDRInvocationInfo.html#ae7274d94c79a78a4cd0976cbe572ab26">UDRInvocationInfo::addPassThruColumns()</a> </dd></dl> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ad6be4c301a7f3b9a34d2c0863fa3d337"></a><!-- doxytag: member="tmudr::ProvenanceInfo::ProvenanceInfo" ref="ad6be4c301a7f3b9a34d2c0863fa3d337" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ProvenanceInfo::ProvenanceInfo </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Default constructor, generates unspecified provenance. </p> + +</div> +</div> +<a class="anchor" id="afe9e921ca4bbbe70f2ad1cdbc27618b5"></a><!-- doxytag: member="tmudr::ProvenanceInfo::ProvenanceInfo" ref="afe9e921ca4bbbe70f2ad1cdbc27618b5" args="(int inputTableNum, int inputColNum)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ProvenanceInfo::ProvenanceInfo </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>inputTableNum</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>inputColNum</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor to link an output column to a specific input column</p> +<p>This constructor can be used to produce a "passthru column". An easier way to do this is the <a class="el" href="classtmudr_1_1UDRInvocationInfo.html#ae7274d94c79a78a4cd0976cbe572ab26">UDRInvocationInfo::addPassThruColumns()</a> method.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>inputTableNum</em> </td><td>Input table number (0 for a TMUDF with a single table-valued input, the most common case). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>inputColNum</em> </td><td>Column number in intput table "inputTableNum" that is the source of the output column to be produced. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a2c10c9b580e812db85cf7c74a35f63c2"></a><!-- doxytag: member="tmudr::ProvenanceInfo::getInputColumnNum" ref="a2c10c9b580e812db85cf7c74a35f63c2" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int ProvenanceInfo::getInputColumnNum </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the input column number.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Input column number. </dd></dl> + +</div> +</div> +<a class="anchor" id="adfad1a87e41077dc3dd62ca4e073b3ef"></a><!-- doxytag: member="tmudr::ProvenanceInfo::getInputTableNum" ref="adfad1a87e41077dc3dd62ca4e073b3ef" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int ProvenanceInfo::getInputTableNum </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Get the input table number.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Input table number. </dd></dl> + +</div> +</div> +<a class="anchor" id="ad8d8d8c7b33c849000f0fd33e9d6c797"></a><!-- doxytag: member="tmudr::ProvenanceInfo::isFromInputTable" ref="ad8d8d8c7b33c849000f0fd33e9d6c797" args="(int inputTableNum=-1) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool ProvenanceInfo::isFromInputTable </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>inputTableNum</em> = <code>-1</code></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Test whether the column comes from any or from a specific table-valued input.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>inputTableNum</em> </td><td>-1 to test for any table-valued input, or a specific input table number. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if the provenance indicates a column that comes from the specified input table(s), false otherwise </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> +<li>sqludr.cpp</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on 31 Aug 2016 for tmudr by +<a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1TableInfo.gif ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1TableInfo.gif b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1TableInfo.gif new file mode 100644 index 0000000..820bd26 Binary files /dev/null and b/docs/apidocs/2.0.1/tmudr_doxygen/html/classtmudr_1_1TableInfo.gif differ
