blob: 512b5f32c25e87ccbdc8f3bfb0d34084e94db1c8 [file] [log] [blame]
<!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:05 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.trafodion.sql.udr (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="org.trafodion.sql.udr (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/trafodion/sql/udr/predef/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/trafodion/sql/udr/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.trafodion.sql.udr</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/CardinalityConstraintInfo.html" title="class in org.trafodion.sql.udr">CardinalityConstraintInfo</a></td>
<td class="colLast">
<div class="block">A cardinality constraint</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a></td>
<td class="colLast">
<div class="block">Describes a column in an input or output table or a parameter</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html" title="class in org.trafodion.sql.udr">ComparisonPredicateInfo</a></td>
<td class="colLast">
<div class="block">A comparison predicate to be evaluated on a table
A predicate that compares a column value to a constant or
another value that evaluates to a constant at runtime,
like an SQL query parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr">ConstraintInfo</a></td>
<td class="colLast">
<div class="block">A constraint on a table-valued input or output table</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmCharsetCoder.html" title="class in org.trafodion.sql.udr">LmCharsetCoder</a></td>
<td class="colLast">
<div class="block">Java class to Character encoding and decoding between different
character sets and Unicode</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmClassLoader.html" title="class in org.trafodion.sql.udr">LmClassLoader</a></td>
<td class="colLast">
<div class="block">LmClassLoader is an extension of URLClassLoader which in turn is
derived from SecureClassLoader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmT2Driver.html" title="class in org.trafodion.sql.udr">LmT2Driver</a></td>
<td class="colLast">
<div class="block">Description: A driver class servicing the following URLs
- "jdbc:sqlmx:" (JDBC/MX Type 2 connection)
- "jdbc:default:connection" (Default connection)
By default, Default Connections will be mapped to Type 4 connections.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmUDRObjMethodInvoke.html" title="class in org.trafodion.sql.udr">LmUDRObjMethodInvoke</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmUDRObjMethodInvoke.ReturnInfo.html" title="class in org.trafodion.sql.udr">LmUDRObjMethodInvoke.ReturnInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/LmUtility.html" title="class in org.trafodion.sql.udr">LmUtility</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/OrderInfo.html" title="class in org.trafodion.sql.udr">OrderInfo</a></td>
<td class="colLast">
<div class="block">Ordering of a table by some ascending or descending columns</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ParameterListInfo.html" title="class in org.trafodion.sql.udr">ParameterListInfo</a></td>
<td class="colLast">
<div class="block">Describes the parameters of a UDR.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a></td>
<td class="colLast">
<div class="block">Partitioning key of an input table or result table</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></td>
<td class="colLast">
<div class="block">A predicate to be evaluated on a table
These could be different kinds of predicates, like an equals
predicate, a non-equals predicate or more complex cases.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a></td>
<td class="colLast">
<div class="block">Describes where an output column is coming from.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TableInfo.html" title="class in org.trafodion.sql.udr">TableInfo</a></td>
<td class="colLast">
<div class="block">Describes a table-valued input or a table-valued output</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TupleInfo.html" title="class in org.trafodion.sql.udr">TupleInfo</a></td>
<td class="colLast">
<div class="block">Common base class for parameter lists and row layouts</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a></td>
<td class="colLast">
<div class="block">Data types in the UDR interface</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDR.html" title="class in org.trafodion.sql.udr">UDR</a></td>
<td class="colLast">
<div class="block">This class represents the code associated with a UDR.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDR.QueueStateInfo.html" title="class in org.trafodion.sql.udr">UDR.QueueStateInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.html" title="class in org.trafodion.sql.udr">UDRInvocationInfo</a></td>
<td class="colLast">
<div class="block">Describes an invocation of a UDR</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html" title="class in org.trafodion.sql.udr">UDRPlanInfo</a></td>
<td class="colLast">
<div class="block">Describes the query plan used for a UDR invocation</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.html" title="class in org.trafodion.sql.udr">UDRWriterCompileTimeData</a></td>
<td class="colLast">
<div class="block">Compile time data owned by the UDR writer</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UniqueConstraintInfo.html" title="class in org.trafodion.sql.udr">UniqueConstraintInfo</a></td>
<td class="colLast">
<div class="block">A uniqueness constraint</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a></td>
<td class="colLast">
<div class="block">Info on whether a table-valued input or output column is used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a></td>
<td class="colLast">
<div class="block">Type of a constraint</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a></td>
<td class="colLast">
<div class="block">Ascending/descending order of columns</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></td>
<td class="colLast">
<div class="block">Type of partitioning</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a></td>
<td class="colLast">
<div class="block">Info on whether a table-valued input or output column is used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/PredicateInfo.PredOperator.html" title="enum in org.trafodion.sql.udr">PredicateInfo.PredOperator</a></td>
<td class="colLast">
<div class="block">Operator of a relational (comparison) predicate</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a></td>
<td class="colLast">
<div class="block">Character sets</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a></td>
<td class="colLast">
<div class="block">Collations</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a></td>
<td class="colLast">
<div class="block">Start and end fields of interval columns</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeClassCode</a></td>
<td class="colLast">
<div class="block">Classes of types defined in the SQL standard</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a></td>
<td class="colLast">
<div class="block">SQL data types</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeSubClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeSubClassCode</a></td>
<td class="colLast">
<div class="block">More detailed type information, but not as detailed as the actual type</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.CallPhase.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.CallPhase</a></td>
<td class="colLast">
<div class="block">Call phase for the UDR interface</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.DebugFlags.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.DebugFlags</a></td>
<td class="colLast">
<div class="block">Values used for the UDR_DEBUG_FLAGS CQD</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.FuncType.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.FuncType</a></td>
<td class="colLast">
<div class="block">Type of a TMUDF: Generic, Mapper or Reducer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.IsolationType.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.IsolationType</a></td>
<td class="colLast">
<div class="block">Indicates the level of trust the system has in the UDR.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.SQLAccessType.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.SQLAccessType</a></td>
<td class="colLast">
<div class="block">Type of SQL operations done in the UDF</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.SQLRightsType.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.SQLRightsType</a></td>
<td class="colLast">
<div class="block">Indicates what the effective user id for SQL operations
performed by the UDR.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.SQLTransactionType.html" title="enum in org.trafodion.sql.udr">UDRInvocationInfo.SQLTransactionType</a></td>
<td class="colLast">
<div class="block">Indicates whether the UDF needs a transaction and
possibly which type of transaction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a></td>
<td class="colLast">
<div class="block">Special degrees of parallelism.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></td>
<td class="colLast">
<div class="block">This is the exception to throw when an error occurs in a UDR.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/trafodion/sql/udr/predef/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/trafodion/sql/udr/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</body>
</html>