blob: 951d1c34982ba1f71f96ef2063792a240329dd7d [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.8.0_181-google-v7) on Wed Aug 14 17:37:16 PDT 2019 -->
<title>org.apache.beam.sdk.extensions.sql.impl (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.beam.sdk.extensions.sql.impl (Apache Beam 2.15.0-SNAPSHOT)";
}
}
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>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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-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/apache/beam/sdk/extensions/sql/example/model/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/parser/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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.apache.beam.sdk.extensions.sql.impl</h1>
<div class="docSummary">
<div class="block">Implementation classes of BeamSql.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlPipelineOptions.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">BeamSqlPipelineOptions</a></td>
<td class="colLast">
<div class="block">Options used to configure BeamSQL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></td>
<td class="colLast">
<div class="block">An interface that planners should implement to convert sql statement to <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamRelNode</code></a> or
<code>SqlNode</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" 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/apache/beam/sdk/extensions/sql/impl/BeamCalciteSchema.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamCalciteSchema</a></td>
<td class="colLast">
<div class="block">Adapter from <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider"><code>TableProvider</code></a> to <code>Schema</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamCalciteTable.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamCalciteTable</a></td>
<td class="colLast">
<div class="block">Adapter from <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql"><code>BeamSqlTable</code></a> to a calcite Table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlEnv.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamSqlEnv</a></td>
<td class="colLast">
<div class="block">Contains the metadata of tables/UDF functions, and exposes APIs to
query/validate/optimize/translate SQL statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlEnv.BeamSqlEnvBuilder.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamSqlEnv.BeamSqlEnvBuilder</a></td>
<td class="colLast">
<div class="block">BeamSqlEnv's Builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamSqlPipelineOptionsRegistrar</a></td>
<td class="colLast">
<div class="block"><code>AutoService</code> registrar for <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlPipelineOptions.html" title="interface in org.apache.beam.sdk.extensions.sql.impl"><code>BeamSqlPipelineOptions</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a></td>
<td class="colLast">
<div class="block">This class stores row count statistics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteConnectionWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl">CalciteConnectionWrapper</a></td>
<td class="colLast">
<div class="block">Abstract wrapper for <code>CalciteConnection</code> to simplify extension.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteFactoryWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl">CalciteFactoryWrapper</a></td>
<td class="colLast">
<div class="block">Wrapper for <code>CalciteFactory</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcConnection.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcConnection</a></td>
<td class="colLast">
<div class="block">Beam JDBC Connection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcDriver.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcDriver</a></td>
<td class="colLast">
<div class="block">Calcite JDBC driver with Beam defaults.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ScalarFunctionImpl</a></td>
<td class="colLast">
<div class="block">Beam-customized version from <code>ScalarFunctionImpl</code>, to
address BEAM-5921.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdafImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdafImpl</a>&lt;InputT,AccumT,OutputT&gt;</td>
<td class="colLast">
<div class="block">Implement <code>AggregateFunction</code> to take a <a href="../../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> as UDAF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase</a></td>
<td class="colLast">
<div class="block">Beam-customized version from <code>ReflectiveFunctionBase</code>, to address BEAM-5921.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.ParameterListBuilder.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase.ParameterListBuilder</a></td>
<td class="colLast">
<div class="block">Helps build lists of <code>FunctionParameter</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" 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/apache/beam/sdk/extensions/sql/impl/ParseException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ParseException</a></td>
<td class="colLast">
<div class="block">Exception thrown when Beam SQL is unable to parse the statement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/SqlConversionException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">SqlConversionException</a></td>
<td class="colLast">
<div class="block">Exception thrown when BeamSQL cannot convert sql to BeamRelNode.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.extensions.sql.impl Description">Package org.apache.beam.sdk.extensions.sql.impl Description</h2>
<div class="block">Implementation classes of BeamSql.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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-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/apache/beam/sdk/extensions/sql/example/model/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/parser/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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 ======= -->
</body>
</html>