| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.7.0_251) on Sat May 02 18:54:03 PDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PartitionInfo (trafodion-sql 2.4.0 API)</title> |
| <meta name="date" content="2020-05-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PartitionInfo (trafodion-sql 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PartitionInfo.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/trafodion/sql/udr/ParameterListInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/trafodion/sql/udr/PartitionInfo.html" target="_top">Frames</a></li> |
| <li><a href="PartitionInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.trafodion.sql.udr</div> |
| <h2 title="Class PartitionInfo" class="title">Class PartitionInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.trafodion.sql.udr.PartitionInfo</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">PartitionInfo</span> |
| extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Partitioning key of an input table or result table |
| |
| <p> Describes the partitioning key of a table-valued input or |
| result. When executing a UDR 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.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></strong></code> |
| <div class="block">Type of partitioning</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#PartitionInfo()">PartitionInfo</a></strong>()</code> |
| <div class="block">Default constructor</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#PartitionInfo(org.trafodion.sql.udr.PartitionInfo)">PartitionInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a> p)</code> |
| <div class="block">Copy constructor</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#addEntry(int)">addEntry</a></strong>(int colNum)</code> |
| <div class="block">Add a new column to the list of partitioning columns</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getColumnNum(int)">getColumnNum</a></strong>(int i)</code> |
| <div class="block">Get the number/ordinal of the ith partitioning column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getNumEntries()">getNumEntries</a></strong>()</code> |
| <div class="block">Get the number of columns that form the partitioning key</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getType()">getType</a></strong>()</code> |
| <div class="block">Get the partitioning type</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#setType(org.trafodion.sql.udr.PartitionInfo.PartitionTypeCode)">setType</a></strong>(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> type)</code> |
| <div class="block">Set the partitioning type.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PartitionInfo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PartitionInfo</h4> |
| <pre>public PartitionInfo()</pre> |
| <div class="block">Default constructor |
| |
| <p> Use this constructor to generate an object to be passed |
| to UDRInvocationInfo::setChildPartitioning()</div> |
| </li> |
| </ul> |
| <a name="PartitionInfo(org.trafodion.sql.udr.PartitionInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PartitionInfo</h4> |
| <pre>public PartitionInfo(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a> p)</pre> |
| <div class="block">Copy constructor</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> getType()</pre> |
| <div class="block">Get the partitioning type</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Partition type enum</dd></dl> |
| </li> |
| </ul> |
| <a name="getNumEntries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumEntries</h4> |
| <pre>public int getNumEntries()</pre> |
| <div class="block">Get the number of columns that form the partitioning key |
| |
| <p> Returns the number of columns in the list of partitioning keys |
| or zero if there are no such columns.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Number of partitioning key columns (could be zero)</dd></dl> |
| </li> |
| </ul> |
| <a name="getColumnNum(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnNum</h4> |
| <pre>public int getColumnNum(int i) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the number/ordinal of the ith partitioning column.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Number/ordinal (0-based) of the ith partitioning column in |
| the list of partitioning columns.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="setType(org.trafodion.sql.udr.PartitionInfo.PartitionTypeCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>public void setType(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> type)</pre> |
| <div class="block">Set the partitioning type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Partition type enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="addEntry(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addEntry</h4> |
| <pre>public void addEntry(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a new column to the list of partitioning columns |
| |
| <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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Number of the column (ordinal, 0-based) of the |
| associated table.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PartitionInfo.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/trafodion/sql/udr/ParameterListInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/trafodion/sql/udr/PartitionInfo.html" target="_top">Frames</a></li> |
| <li><a href="PartitionInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |
