blob: 9d4ea81a9c93cc765b4afc806e503b6cd1229403 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SqlParser (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="SqlParser (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SqlParser.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.sql.parser</a></div>
<h2 title="Class SqlParser" class="title">Class SqlParser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.sql.parser.SqlParser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">SqlParser</span>
extends java.lang.Object</pre>
<div class="block">A <code>SqlParser</code> parses a SQL statement.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></span></code></th>
<td class="colLast">
<div class="block">Interface to define the configuration for a SQL parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></span></code></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="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlParser.ConfigImpl.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigImpl</a></span></code></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>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_ALLOW_BANG_EQUAL">DEFAULT_ALLOW_BANG_EQUAL</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_IDENTIFIER_MAX_LENGTH">DEFAULT_IDENTIFIER_MAX_LENGTH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parser">parser</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.parser.SqlAbstractParserImpl,org.apache.calcite.sql.parser.SqlParser.Config)">SqlParser</a></span>&#8203;(<a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl</a>&nbsp;parser,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configBuilder()">configBuilder</a></span>()</code></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 id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configBuilder(org.apache.calcite.sql.parser.SqlParser.Config)">configBuilder</a></span>&#8203;(<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</code></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> that starts with an existing <code>Config</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.io.Reader,org.apache.calcite.sql.parser.SqlParser.Config)">create</a></span>&#8203;(java.io.Reader&nbsp;reader,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Creates a <code>SqlParser</code> to parse the given string using the
parser implementation created from given <a href="SqlParserImplFactory.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParserImplFactory</code></a>
with given quoting syntax and casing policies for identifiers.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String)">create</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Creates a <code>SqlParser</code> to parse the given string using
Calcite's parser implementation.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)">create</a></span>&#8203;(java.lang.String&nbsp;sql,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Creates a <code>SqlParser</code> to parse the given string using the
parser implementation created from given <a href="SqlParserImplFactory.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParserImplFactory</code></a>
with given quoting syntax and casing policies for identifiers.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="SqlAbstractParserImpl.Metadata.html" title="interface in org.apache.calcite.sql.parser">SqlAbstractParserImpl.Metadata</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetadata()">getMetadata</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the parser metadata.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleException(java.lang.Throwable)">handleException</a></span>&#8203;(java.lang.Throwable&nbsp;ex)</code></th>
<td class="colLast">
<div class="block">Normalizes a SQL exception.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseExpression()">parseExpression</a></span>()</code></th>
<td class="colLast">
<div class="block">Parses a SQL expression.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseQuery()">parseQuery</a></span>()</code></th>
<td class="colLast">
<div class="block">Parses a <code>SELECT</code> statement.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseQuery(java.lang.String)">parseQuery</a></span>&#8203;(java.lang.String&nbsp;sql)</code></th>
<td class="colLast">
<div class="block">Parses a <code>SELECT</code> statement and reuses parser.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseStmt()">parseStmt</a></span>()</code></th>
<td class="colLast">
<div class="block">Parses an SQL statement.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseStmtList()">parseStmtList</a></span>()</code></th>
<td class="colLast">
<div class="block">Parses a list of SQL statements separated by semicolon.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_IDENTIFIER_MAX_LENGTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_IDENTIFIER_MAX_LENGTH</h4>
<pre>public static final&nbsp;int DEFAULT_IDENTIFIER_MAX_LENGTH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.calcite.sql.parser.SqlParser.DEFAULT_IDENTIFIER_MAX_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_ALLOW_BANG_EQUAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_ALLOW_BANG_EQUAL</h4>
<pre>@Deprecated
public static final&nbsp;boolean DEFAULT_ALLOW_BANG_EQUAL</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="parser">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parser</h4>
<pre>private final&nbsp;<a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl</a> parser</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.calcite.sql.parser.SqlAbstractParserImpl,org.apache.calcite.sql.parser.SqlParser.Config)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SqlParser</h4>
<pre>private&nbsp;SqlParser&#8203;(<a href="SqlAbstractParserImpl.html" title="class in org.apache.calcite.sql.parser">SqlAbstractParserImpl</a>&nbsp;parser,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="create(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a>&nbsp;create&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Creates a <code>SqlParser</code> to parse the given string using
Calcite's parser implementation.
<p>The default lexical policy is similar to Oracle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - An SQL statement or expression to parse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A parser</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../config/Lex.html#ORACLE"><code>Lex.ORACLE</code></a></dd>
</dl>
</li>
</ul>
<a id="create(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a>&nbsp;create&#8203;(java.lang.String&nbsp;sql,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</pre>
<div class="block">Creates a <code>SqlParser</code> to parse the given string using the
parser implementation created from given <a href="SqlParserImplFactory.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParserImplFactory</code></a>
with given quoting syntax and casing policies for identifiers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sql</code> - A SQL statement or expression to parse</dd>
<dd><code>config</code> - The parser configuration (identifier max length, etc.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A parser</dd>
</dl>
</li>
</ul>
<a id="create(java.io.Reader,org.apache.calcite.sql.parser.SqlParser.Config)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a>&nbsp;create&#8203;(java.io.Reader&nbsp;reader,
<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</pre>
<div class="block">Creates a <code>SqlParser</code> to parse the given string using the
parser implementation created from given <a href="SqlParserImplFactory.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParserImplFactory</code></a>
with given quoting syntax and casing policies for identifiers.
<p>Unlike
<a href="#create(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)"><code>create(java.lang.String, org.apache.calcite.sql.parser.SqlParser.Config)</code></a>,
the parser is not able to return the original query string, but will
instead return "?".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reader</code> - The source for the SQL statement or expression to parse</dd>
<dd><code>config</code> - The parser configuration (identifier max length, etc.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A parser</dd>
</dl>
</li>
</ul>
<a id="parseExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseExpression</h4>
<pre class="methodSignature">public&nbsp;<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;parseExpression()
throws <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block">Parses a SQL expression.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - if there is a parse error</dd>
</dl>
</li>
</ul>
<a id="handleException(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleException</h4>
<pre class="methodSignature">private&nbsp;<a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a>&nbsp;handleException&#8203;(java.lang.Throwable&nbsp;ex)</pre>
<div class="block">Normalizes a SQL exception.</div>
</li>
</ul>
<a id="parseQuery()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseQuery</h4>
<pre class="methodSignature">public&nbsp;<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;parseQuery()
throws <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block">Parses a <code>SELECT</code> statement.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../SqlSelect.html" title="class in org.apache.calcite.sql"><code>SqlSelect</code></a> for a regular <code>
SELECT</code> statement; a <a href="../SqlBinaryOperator.html" title="class in org.apache.calcite.sql"><code>SqlBinaryOperator</code></a>
for a <code>UNION</code>, <code>INTERSECT</code>, or <code>EXCEPT</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - if there is a parse error</dd>
</dl>
</li>
</ul>
<a id="parseQuery(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseQuery</h4>
<pre class="methodSignature">public&nbsp;<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;parseQuery&#8203;(java.lang.String&nbsp;sql)
throws <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block">Parses a <code>SELECT</code> statement and reuses parser.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sql</code> - sql to parse</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../SqlSelect.html" title="class in org.apache.calcite.sql"><code>SqlSelect</code></a> for a regular <code>
SELECT</code> statement; a <a href="../SqlBinaryOperator.html" title="class in org.apache.calcite.sql"><code>SqlBinaryOperator</code></a>
for a <code>UNION</code>, <code>INTERSECT</code>, or <code>EXCEPT</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - if there is a parse error</dd>
</dl>
</li>
</ul>
<a id="parseStmt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseStmt</h4>
<pre class="methodSignature">public&nbsp;<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;parseStmt()
throws <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block">Parses an SQL statement.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>top-level SqlNode representing stmt</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - if there is a parse error</dd>
</dl>
</li>
</ul>
<a id="parseStmtList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseStmtList</h4>
<pre class="methodSignature">public&nbsp;<a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>&nbsp;parseStmtList()
throws <a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block">Parses a list of SQL statements separated by semicolon.
The semicolon is required between statements, but is
optional at the end.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of SqlNodeList representing the list of SQL statements</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - if there is a parse error</dd>
</dl>
</li>
</ul>
<a id="getMetadata()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre class="methodSignature">public&nbsp;<a href="SqlAbstractParserImpl.Metadata.html" title="interface in org.apache.calcite.sql.parser">SqlAbstractParserImpl.Metadata</a>&nbsp;getMetadata()</pre>
<div class="block">Get the parser metadata.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SqlAbstractParserImpl.Metadata.html" title="interface in org.apache.calcite.sql.parser"><code>SqlAbstractParserImpl.Metadata</code></a> implementation of
underlying parser.</dd>
</dl>
</li>
</ul>
<a id="configBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configBuilder</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a>&nbsp;configBuilder()</pre>
<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>
</li>
</ul>
<a id="configBuilder(org.apache.calcite.sql.parser.SqlParser.Config)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configBuilder</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a>&nbsp;configBuilder&#8203;(<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;config)</pre>
<div class="block">Builder for a <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParser.Config</code></a> that starts with an existing <code>Config</code>.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SqlParser.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>