| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.sql.advise (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.sql.advise"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package org.apache.calcite.sql.advise" class="title">Package org.apache.calcite.sql.advise</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.calcite.sql.advise</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides hints and corrections for editing SQL statements. |
| |
| <p>The SQL statement might be partially-formed SQL statement or |
| invalid. It is edited in a SQL editor user-interface.</p> |
| |
| <p>The advisor uses the validation and parser framework set up in |
| <code>org.apache.calcite.sql.validate</code> package.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite.sql</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides a SQL parser and object model.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="caption"><span>Classes</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlAdvisor.html" title="class in org.apache.calcite.sql.advise">SqlAdvisor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An assistant which offers hints and corrections to a partially-formed SQL |
| statement.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SqlAdvisor.ValidateErrorInfo.html" title="class in org.apache.calcite.sql.advise">SqlAdvisor.ValidateErrorInfo</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Text and position info of a validator or parser exception.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlAdvisorGetHintsFunction.html" title="class in org.apache.calcite.sql.advise">SqlAdvisorGetHintsFunction</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Table function that returns completion hints for a given SQL statement.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SqlAdvisorGetHintsFunction2.html" title="class in org.apache.calcite.sql.advise">SqlAdvisorGetHintsFunction2</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Table function that returns completion hints for a given SQL statement.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlAdvisorHint.html" title="class in org.apache.calcite.sql.advise">SqlAdvisorHint</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">This class is used to return values for |
| <a href="SqlAdvisor.html#getCompletionHints(java.lang.String,int,java.lang.String%5B%5D)"><code>(String, int, String[])</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SqlAdvisorHint2.html" title="class in org.apache.calcite.sql.advise">SqlAdvisorHint2</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">This class is used to return values for |
| <a href="SqlAdvisor.html#getCompletionHints(java.lang.String,int,java.lang.String%5B%5D)"><code>(String, int, String[])</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlAdvisorValidator.html" title="class in org.apache.calcite.sql.advise">SqlAdvisorValidator</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>SqlAdvisorValidator</code> is used by <a href="SqlAdvisor.html" title="class in org.apache.calcite.sql.advise"><code>SqlAdvisor</code></a> to traverse |
| the parse tree of a SQL statement, not for validation purpose but for setting |
| up the scopes and namespaces to facilitate retrieval of SQL statement |
| completion hints.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SqlSimpleParser.html" title="class in org.apache.calcite.sql.advise">SqlSimpleParser</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A simple parser that takes an incomplete and turn it into a syntactically |
| correct statement.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlSimpleParser.IdToken.html" title="class in org.apache.calcite.sql.advise">SqlSimpleParser.IdToken</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Token representing an identifier.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SqlSimpleParser.Token.html" title="class in org.apache.calcite.sql.advise">SqlSimpleParser.Token</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Token.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SqlSimpleParser.Tokenizer.html" title="class in org.apache.calcite.sql.advise">SqlSimpleParser.Tokenizer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Tokenizer.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
