| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlParser (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.parser, class: SqlParser"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.sql.parser</a></div> |
| <h1 title="Class SqlParser" class="title">Class SqlParser</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.parser.SqlParser</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Enclosing |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">SqlParser</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">A <code>SqlParser</code> parses a SQL statement.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="SqlParser.Config.html" class="type-name-link" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Interface to define the configuration for a SQL parser.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="SqlParser.ConfigBuilder.html" class="type-name-link" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_ALLOW_BANG_EQUAL" class="member-name-link">DEFAULT_ALLOW_BANG_EQUAL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_IDENTIFIER_MAX_LENGTH" class="member-name-link">DEFAULT_IDENTIFIER_MAX_LENGTH</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final com.google.common.collect.ImmutableMap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.calcite.avatica.util.TimeUnit></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_IDENTIFIER_TIMEUNIT_MAP" class="member-name-link">DEFAULT_IDENTIFIER_TIMEUNIT_MAP</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#config()" class="member-name-link">config</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a default <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParser.Config</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#configBuilder()" class="member-name-link">configBuilder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#config()"><code>config()</code></a></div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#configBuilder(org.apache.calcite.sql.parser.SqlParser.Config)" class="member-name-link">configBuilder</a><wbr>(<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <code>config</code>, and modify it using its mutator methods</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.io.Reader,org.apache.calcite.sql.parser.SqlParser.Config)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader, |
| <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.lang.String)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a <code>SqlParser</code> to parse the given string using |
| Calcite's parser implementation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, |
| <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.calcite.sql.parser.SqlAbstractParserImpl.Metadata</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetadata()" class="member-name-link">getMetadata</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the parser metadata.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../runtime/CalciteContextException.html" title="class in org.apache.calcite.runtime">CalciteContextException</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWarnings()" class="member-name-link">getWarnings</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the warnings that were generated by the previous invocation |
| of the parser.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseExpression()" class="member-name-link">parseExpression</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parses a SQL expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseQuery()" class="member-name-link">parseQuery</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parses a <code>SELECT</code> statement.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseQuery(java.lang.String)" class="member-name-link">parseQuery</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parses a <code>SELECT</code> statement and reuses parser.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseStmt()" class="member-name-link">parseStmt</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parses an SQL statement.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseStmtList()" class="member-name-link">parseStmtList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parses a list of SQL statements separated by semicolon.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_IDENTIFIER_MAX_LENGTH"> |
| <h3>DEFAULT_IDENTIFIER_MAX_LENGTH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_IDENTIFIER_MAX_LENGTH</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.sql.parser.SqlParser.DEFAULT_IDENTIFIER_MAX_LENGTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_IDENTIFIER_TIMEUNIT_MAP"> |
| <h3>DEFAULT_IDENTIFIER_TIMEUNIT_MAP</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="return-type">com.google.common.collect.ImmutableMap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>org.apache.calcite.avatica.util.TimeUnit></span> <span class="element-name">DEFAULT_IDENTIFIER_TIMEUNIT_MAP</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Default value of <a href="SqlParser.Config.html#timeUnitCodes()"><code>SqlParser.Config.timeUnitCodes()</code></a>. |
| The map is empty, which means that there are no abbreviations other than |
| the time unit names ("YEAR", "SECOND", etc.)</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_ALLOW_BANG_EQUAL"> |
| <h3>DEFAULT_ALLOW_BANG_EQUAL</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name">DEFAULT_ALLOW_BANG_EQUAL</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="create(java.lang.String)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>s</code> - An SQL statement or expression to parse.</dd> |
| <dt>Returns:</dt> |
| <dd>A parser</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../config/Lex.html#ORACLE"><code>Lex.ORACLE</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, |
| <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>A parser</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.io.Reader,org.apache.calcite.sql.parser.SqlParser.Config)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader, |
| <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>A parser</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseExpression()"> |
| <h3>parseExpression</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">parseExpression</span>() |
| throws <span class="exceptions"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses a SQL expression.</div> |
| <dl class="notes"> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseQuery()"> |
| <h3>parseQuery</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">parseQuery</span>() |
| throws <span class="exceptions"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses a <code>SELECT</code> statement.</div> |
| <dl class="notes"> |
| <dt>Returns:</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>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseQuery(java.lang.String)"> |
| <h3>parseQuery</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">parseQuery</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql)</span> |
| throws <span class="exceptions"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses a <code>SELECT</code> statement and reuses parser.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sql</code> - sql to parse</dd> |
| <dt>Returns:</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>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseStmt()"> |
| <h3>parseStmt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">parseStmt</span>() |
| throws <span class="exceptions"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses an SQL statement.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>top-level SqlNode representing stmt</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseStmtList()"> |
| <h3>parseStmtList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></span> <span class="element-name">parseStmtList</span>() |
| throws <span class="exceptions"><a href="SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>list of SqlNodeList representing the list of SQL statements</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetadata()"> |
| <h3>getMetadata</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.calcite.sql.parser.SqlAbstractParserImpl.Metadata</span> <span class="element-name">getMetadata</span>()</div> |
| <div class="block">Get the parser metadata.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>SqlAbstractParserImpl.Metadata</code> implementation of |
| underlying parser.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarnings()"> |
| <h3>getWarnings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../runtime/CalciteContextException.html" title="class in org.apache.calcite.runtime">CalciteContextException</a>></span> <span class="element-name">getWarnings</span>()</div> |
| <div class="block">Returns the warnings that were generated by the previous invocation |
| of the parser.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="config()"> |
| <h3>config</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></span> <span class="element-name">config</span>()</div> |
| <div class="block">Returns a default <a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser"><code>SqlParser.Config</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configBuilder()"> |
| <h3>configBuilder</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></span> <span class="element-name">configBuilder</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#config()"><code>config()</code></a></div> |
| </div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configBuilder(org.apache.calcite.sql.parser.SqlParser.Config)"> |
| <h3>configBuilder</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></span> <span class="element-name">configBuilder</span><wbr><span class="parameters">(<a href="SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <code>config</code>, and modify it using its mutator methods</div> |
| </div> |
| <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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |