blob: 5a0828f596e5899a49a7e306a9be5daedd8502ad [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.sql.parser (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.sql.parser (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.sql.parser</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Provides a SQL parser.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="SqlAbstractParserImpl.Metadata.html" title="interface in org.apache.calcite.sql.parser">SqlAbstractParserImpl.Metadata</a></th>
<td class="colLast">
<div class="block">Metadata about the parser.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></th>
<td class="colLast">
<div class="block">Interface to define the configuration for a SQL parser.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserImplFactory.html" title="interface in org.apache.calcite.sql.parser">SqlParserImplFactory</a></th>
<td class="colLast">
<div class="block">Factory for
<a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser"><code>SqlAbstractParserImpl</code></a> objects.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="Span.html" title="class in org.apache.calcite.sql.parser">Span</a></th>
<td class="colLast">
<div class="block">Builder for <a href="SqlParserPos.html" title="class in org.apache.calcite.sql.parser"><code>SqlParserPos</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl</a></th>
<td class="colLast">
<div class="block">Abstract base for parsers generated from CommonParser.jj.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlAbstractParserImpl.MetadataImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl.MetadataImpl</a></th>
<td class="colLast">
<div class="block">Default implementation of the <a href="SqlAbstractParserImpl.Metadata.html" title="interface in org.apache.calcite.sql.parser"><code>SqlAbstractParserImpl.Metadata</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></th>
<td class="colLast">
<div class="block">A <code>SqlParser</code> parses a SQL statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></th>
<td class="colLast">
<div class="block">Builder for a <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParser.Config</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParser.ConfigImpl.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigImpl</a></th>
<td class="colLast">
<div class="block">Implementation of
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParser.Config</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></th>
<td class="colLast">
<div class="block">SqlParserPos represents the position of a parsed token within SQL statement
text.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParserPos.QuotedParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos.QuotedParserPos</a></th>
<td class="colLast">
<div class="block">Parser position for an identifier segment that is quoted.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil</a></th>
<td class="colLast">
<div class="block">Utility methods relating to parsing SQL.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.Format.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.Format</a></th>
<td class="colLast">
<div class="block">Pre-initialized <code>DateFormat</code> objects, to be used within the current
thread, because <code>DateFormat</code> is not thread-safe.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.OldTokenSequenceImpl.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.OldTokenSequenceImpl</a></th>
<td class="colLast">
<div class="block">Implementation of
<a href="../SqlSpecialOperator.TokenSequence.html" title="interface in org.apache.calcite.sql"><code>SqlSpecialOperator.TokenSequence</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.ParsedCollation.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.ParsedCollation</a></th>
<td class="colLast">
<div class="block">The components of a collation definition, per the SQL standard.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.StringAndPos.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.StringAndPos</a></th>
<td class="colLast">
<div class="block">Contains a string, the offset of a token within the string, and a parser
position containing the beginning and end line number.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.TokenSequenceImpl.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.TokenSequenceImpl</a></th>
<td class="colLast">
<div class="block">Implementation of
<a href="../SqlSpecialOperator.TokenSequence.html" title="interface in org.apache.calcite.sql"><code>SqlSpecialOperator.TokenSequence</code></a>
based on an existing parser.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlParserUtil.ToTreeListItem.html" title="class in org.apache.calcite.sql.parser">SqlParserUtil.ToTreeListItem</a></th>
<td class="colLast">
<div class="block">Class that holds a <a href="../SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a> and a <a href="SqlParserPos.html" title="class in org.apache.calcite.sql.parser"><code>SqlParserPos</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="SqlAbstractParserImpl.ExprContext.html" title="enum in org.apache.calcite.sql.parser">SqlAbstractParserImpl.ExprContext</a></th>
<td class="colLast">
<div class="block">Type-safe enum for context of acceptable expressions.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></th>
<td class="colLast">
<div class="block">SqlParseException defines a checked exception corresponding to
<a href="SqlParser.html" title="class in org.apache.calcite.sql.parser"><code>SqlParser</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>