| <!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 Mon Jan 27 16:42:27 PST 2020 --> |
| <title>CalciteQueryPlanner (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="CalciteQueryPlanner (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/impl/CalciteFactoryWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.NonCumulativeCostImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html" target="_top">Frames</a></li> |
| <li><a href="CalciteQueryPlanner.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.apache.beam.sdk.extensions.sql.impl</div> |
| <h2 title="Class CalciteQueryPlanner" class="title">Class CalciteQueryPlanner</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.extensions.sql.impl.CalciteQueryPlanner</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CalciteQueryPlanner</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></pre> |
| <div class="block">The core component to handle through a SQL statement, from explain execution plan, to generate a |
| Beam pipeline.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.NonCumulativeCostImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">CalciteQueryPlanner.NonCumulativeCostImpl</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.QueryPlanner"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.extensions.sql.impl.<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.QueryParameters.html" title="class in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner.QueryParameters</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html#CalciteQueryPlanner-org.apache.beam.sdk.extensions.sql.impl.JdbcConnection-org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet:A-">CalciteQueryPlanner</a></span>(<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcConnection.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcConnection</a> connection, |
| org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet[] ruleSets)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel">BeamRelNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html#convertToBeamRel-java.lang.String-org.apache.beam.sdk.extensions.sql.impl.QueryPlanner.QueryParameters-">convertToBeamRel</a></span>(java.lang.String sqlStatement, |
| <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.QueryParameters.html" title="class in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner.QueryParameters</a> queryParameters)</code> |
| <div class="block">It parses and validate the input query, then convert into a <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> tree.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.FrameworkConfig</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html#defaultConfig-org.apache.beam.sdk.extensions.sql.impl.JdbcConnection-org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet:A-">defaultConfig</a></span>(<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcConnection.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcConnection</a> connection, |
| org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet[] ruleSets)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.sql.SqlNode</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html#parse-java.lang.String-">parse</a></span>(java.lang.String sqlStatement)</code> |
| <div class="block">Parse input SQL query, and return a <code>SqlNode</code> as grammar tree.</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="CalciteQueryPlanner-org.apache.beam.sdk.extensions.sql.impl.JdbcConnection-org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CalciteQueryPlanner</h4> |
| <pre>public CalciteQueryPlanner(<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcConnection.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcConnection</a> connection, |
| org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet[] ruleSets)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="defaultConfig-org.apache.beam.sdk.extensions.sql.impl.JdbcConnection-org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultConfig</h4> |
| <pre>public org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.FrameworkConfig defaultConfig(<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/JdbcConnection.html" title="class in org.apache.beam.sdk.extensions.sql.impl">JdbcConnection</a> connection, |
| org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.tools.RuleSet[] ruleSets)</pre> |
| </li> |
| </ul> |
| <a name="parse-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre>public org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.sql.SqlNode parse(java.lang.String sqlStatement) |
| throws <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ParseException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ParseException</a></pre> |
| <div class="block">Parse input SQL query, and return a <code>SqlNode</code> as grammar tree.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html#parse-java.lang.String-">parse</a></code> in interface <code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ParseException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ParseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertToBeamRel-java.lang.String-org.apache.beam.sdk.extensions.sql.impl.QueryPlanner.QueryParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertToBeamRel</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel">BeamRelNode</a> convertToBeamRel(java.lang.String sqlStatement, |
| <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.QueryParameters.html" title="class in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner.QueryParameters</a> queryParameters) |
| throws <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ParseException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ParseException</a>, |
| <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/SqlConversionException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">SqlConversionException</a></pre> |
| <div class="block">It parses and validate the input query, then convert into a <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> tree. Note that |
| query parameters are not yet supported.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html#convertToBeamRel-java.lang.String-org.apache.beam.sdk.extensions.sql.impl.QueryPlanner.QueryParameters-">convertToBeamRel</a></code> in interface <code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/QueryPlanner.html" title="interface in org.apache.beam.sdk.extensions.sql.impl">QueryPlanner</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ParseException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ParseException</a></code></dd> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/SqlConversionException.html" title="class in org.apache.beam.sdk.extensions.sql.impl">SqlConversionException</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> |
| <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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/impl/CalciteFactoryWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.NonCumulativeCostImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/CalciteQueryPlanner.html" target="_top">Frames</a></li> |
| <li><a href="CalciteQueryPlanner.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 ======= --> |
| </body> |
| </html> |
