| <!-- 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 11 Oct 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> |
