| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlUtil (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, class: SqlUtil"> |
| <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><a href="#constructor-summary">Constr</a> | </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><a href="#constructor-detail">Constr</a> | </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</a></div> |
| <h1 title="Class SqlUtil" class="title">Class SqlUtil</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.SqlUtil</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SqlUtil</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">Contains utility functions related to SQL parsing, all static.</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 class </code></div> |
| <div class="col-second even-row-color"><code><a href="SqlUtil.DatabaseMetaDataInvocationHandler.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlUtil.DatabaseMetaDataInvocationHandler</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Handles particular <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/DatabaseMetaData.html" title="class or interface in java.sql" class="external-link"><code>DatabaseMetaData</code></a> methods; invocations of other |
| methods will fall through to the base class, |
| <a href="../util/BarfingInvocationHandler.html" title="class in org.apache.calcite.util"><code>BarfingInvocationHandler</code></a>, which will throw |
| an error.</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 <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#GENERATED_EXPR_ALIAS_PREFIX" class="member-name-link">GENERATED_EXPR_ALIAS_PREFIX</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Prefix for generated column aliases.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SqlUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </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-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="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-tab1 method-summary-table-tab4"><code><a href="#andExpressions(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)" class="member-name-link">andExpressions</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node2)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the AND of two expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#attachRelHint(org.apache.calcite.rel.hint.HintStrategyTable,java.util.List,org.apache.calcite.rel.hint.Hintable)" class="member-name-link">attachRelHint</a><wbr>(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategies, |
| <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="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../rel/hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Attach the <code>hints</code> to <code>rel</code> with specified hint strategies.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#concatenateLiterals(java.util.List)" class="member-name-link">concatenateLiterals</a><wbr>(<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="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a>> lits)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Concatenates string literals.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#createCall(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.parser.SqlParserPos,java.util.List)" class="member-name-link">createCall</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <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="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands)</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 call to an operator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createNlsStringType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.util.NlsString)" class="member-name-link">createNlsStringType</a><wbr>(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../util/NlsString.html" title="class in org.apache.calcite.util">NlsString</a> str)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates the type of an <a href="../util/NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deriveAliasFromOrdinal(int)" class="member-name-link">deriveAliasFromOrdinal</a><wbr>(int ordinal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getAliasedSignature(org.apache.calcite.sql.SqlOperator,java.lang.String,java.util.List)" class="member-name-link">getAliasedSignature</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <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> opName, |
| <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><?> typeList)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Constructs an operator signature from a type list, substituting an alias |
| for the operator name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static com.google.common.collect.ImmutableList<<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-tab1 method-summary-table-tab4"><code><a href="#getAncestry(org.apache.calcite.sql.SqlNode,java.util.function.Predicate,java.util.function.Predicate)" class="member-name-link">getAncestry</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> root, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> predicate, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> postPredicate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a list of ancestors of <code>predicate</code> within a given |
| <code>SqlNode</code> tree.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCharset(java.lang.String)" class="member-name-link">getCharset</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> charsetName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Java-level <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link"><code>Charset</code></a> based on given SQL-level name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getFromNode(org.apache.calcite.sql.SqlSelect,int)" class="member-name-link">getFromNode</a><wbr>(<a href="SqlSelect.html" title="class in org.apache.calcite.sql">SqlSelect</a> query, |
| int ordinal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the <code>n</code>th (0-based) input to a join expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getOperatorSignature(org.apache.calcite.sql.SqlOperator,java.util.List)" class="member-name-link">getOperatorSignature</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <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><?> typeList)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Constructs an operator signature from a type list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRelHint(org.apache.calcite.rel.hint.HintStrategyTable,org.apache.calcite.sql.SqlNodeList)" class="member-name-link">getRelHint</a><wbr>(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategies, |
| @Nullable <a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> sqlHints)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an immutable list of <a href="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint"><code>RelHint</code></a> from sql hints, with a given |
| inherit path from the root node.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#getSelectListItem(org.apache.calcite.sql.SqlNode,int)" class="member-name-link">getSelectListItem</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> query, |
| int i)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the <code>i</code>th select-list item of a query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#indexOfDeep(java.util.List,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)" class="member-name-link">indexOfDeep</a><wbr>(<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><? extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> list, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> e, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Finds the index of an expression in a list, comparing using |
| <a href="SqlNode.html#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>SqlNode.equalsDeep(SqlNode, Litmus)</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isCallTo(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlOperator)" class="member-name-link">isCallTo</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>node</code></a> is a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>call</code></a> to a |
| given <a href="SqlOperator.html" title="class in org.apache.calcite.sql"><code>operator</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isGeneratedAlias(java.lang.String)" class="member-name-link">isGeneratedAlias</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> alias)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Whether the alias is generated by calcite.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isLiteral(org.apache.calcite.sql.SqlNode)" class="member-name-link">isLiteral</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a node is a literal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isLiteral(org.apache.calcite.sql.SqlNode,boolean)" class="member-name-link">isLiteral</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean allowCast)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a node is a literal.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isLiteralChain(org.apache.calcite.sql.SqlNode)" class="member-name-link">isLiteralChain</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a node is a literal chain which is used to represent a |
| continued string literal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isNull(org.apache.calcite.sql.SqlNode)" class="member-name-link">isNull</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a node represents the NULL value or a series of nested |
| <code>CAST(NULL AS type)</code> calls.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isNullLiteral(org.apache.calcite.sql.SqlNode,boolean)" class="member-name-link">isNullLiteral</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean allowCast)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a node represents the NULL value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lookupRoutine(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlIdentifier,java.util.List,java.util.List,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.SqlSyntax,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.validate.SqlNameMatcher,boolean)" class="member-name-link">lookupRoutine</a><wbr>(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| @Nullable <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="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>> argNames, |
| @Nullable <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a> syntax, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sqlKind, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher, |
| boolean coerce)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Looks up a (possibly overloaded) routine based on name and argument |
| types.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lookupSubjectRoutines(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlIdentifier,java.util.List,java.util.List,org.apache.calcite.sql.SqlSyntax,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.validate.SqlNameMatcher,boolean)" class="member-name-link">lookupSubjectRoutines</a><wbr>(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| @Nullable <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="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>> argNames, |
| <a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a> sqlSyntax, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sqlKind, |
| @Nullable <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher, |
| boolean coerce)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Looks up all subject routines matching the given name and argument types.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#matchRoutinesByParameterCount(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.sql.SqlIdentifier,java.util.List,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.validate.SqlNameMatcher)" class="member-name-link">matchRoutinesByParameterCount</a><wbr>(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Determines whether there is a routine matching the given name and number |
| of arguments.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../runtime/CalciteContextException.html" title="class in org.apache.calcite.runtime">CalciteContextException</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newContextException(int,int,int,int,org.apache.calcite.runtime.Resources.ExInst)" class="member-name-link">newContextException</a><wbr>(int line, |
| int col, |
| int endLine, |
| int endCol, |
| org.apache.calcite.runtime.Resources.ExInst<?> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Wraps an exception with context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#newContextException(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.runtime.Resources.ExInst)" class="member-name-link">newContextException</a><wbr>(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| org.apache.calcite.runtime.Resources.ExInst<?> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Wraps an exception with context.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newContextException(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.runtime.Resources.ExInst,java.lang.String)" class="member-name-link">newContextException</a><wbr>(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| org.apache.calcite.runtime.Resources.ExInst<?> e, |
| <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> inputText)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Wraps an exception with context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @PolyNull <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-tab1 method-summary-table-tab4"><code><a href="#stripAs(org.apache.calcite.sql.SqlNode)" class="member-name-link">stripAs</a><wbr>(@PolyNull <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">If a node is "AS", returns the underlying expression; otherwise returns |
| the node.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#stripListAs(org.apache.calcite.sql.SqlNodeList)" class="member-name-link">stripListAs</a><wbr>(<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Modifies a list of nodes, removing AS from each if present.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toNodeList(org.apache.calcite.sql.SqlNode%5B%5D)" class="member-name-link">toNodeList</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] operands)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Converts a SqlNode array to a SqlNodeList.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#translateCharacterSetName(java.lang.String)" class="member-name-link">translateCharacterSetName</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Translates a character set name from a SQL-level name into a Java-level |
| name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unparseBinarySyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlWriter,int,int)" class="member-name-link">unparseBinarySyntax</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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 void</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="#unparseFunctionSyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall)" class="member-name-link">unparseFunctionSyntax</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unparseFunctionSyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,boolean)" class="member-name-link">unparseFunctionSyntax</a><wbr>(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| boolean ordered)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Unparses a call to an operator that has function syntax.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unparseSqlIdentifierSyntax(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlIdentifier,boolean)" class="member-name-link">unparseSqlIdentifierSyntax</a><wbr>(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> identifier, |
| boolean asFunctionID)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Unparse a SqlIdentifier syntax.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validateCharset(org.apache.calcite.avatica.util.ByteString,java.nio.charset.Charset)" class="member-name-link">validateCharset</a><wbr>(org.apache.calcite.avatica.util.ByteString value, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Validate if value can be decoded by given charset.</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="GENERATED_EXPR_ALIAS_PREFIX"> |
| <h3>GENERATED_EXPR_ALIAS_PREFIX</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">GENERATED_EXPR_ALIAS_PREFIX</span></div> |
| <div class="block">Prefix for generated column aliases. Ends with '$' so that human-written |
| queries are unlikely to accidentally reference the generated name.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.calcite.sql.SqlUtil.GENERATED_EXPR_ALIAS_PREFIX">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SqlUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlUtil</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="andExpressions(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"> |
| <h3>andExpressions</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">andExpressions</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node2)</span></div> |
| <div class="block">Returns the AND of two expressions. |
| |
| <p>If <code>node1</code> is null, returns <code>node2</code>. |
| Flattens if either node is an AND.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFromNode(org.apache.calcite.sql.SqlSelect,int)"> |
| <h3>getFromNode</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getFromNode</span><wbr><span class="parameters">(<a href="SqlSelect.html" title="class in org.apache.calcite.sql">SqlSelect</a> query, |
| int ordinal)</span></div> |
| <div class="block">Returns the <code>n</code>th (0-based) input to a join expression.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toNodeList(org.apache.calcite.sql.SqlNode[])"> |
| <h3>toNodeList</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></span> <span class="element-name">toNodeList</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] operands)</span></div> |
| <div class="block">Converts a SqlNode array to a SqlNodeList.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="indexOfDeep(java.util.List,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"> |
| <h3>indexOfDeep</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">indexOfDeep</span><wbr><span class="parameters">(<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><? extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> list, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> e, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Finds the index of an expression in a list, comparing using |
| <a href="SqlNode.html#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>SqlNode.equalsDeep(SqlNode, Litmus)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNullLiteral(org.apache.calcite.sql.SqlNode,boolean)"> |
| <h3>isNullLiteral</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isNullLiteral</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean allowCast)</span></div> |
| <div class="block">Returns whether a node represents the NULL value. |
| |
| <p>Examples: |
| |
| <ul> |
| <li>For <a href="SqlLiteral.html" title="class in org.apache.calcite.sql"><code>SqlLiteral</code></a> Unknown, returns false. |
| <li>For <code>CAST(NULL AS <i>type</i>)</code>, returns true if <code> |
| allowCast</code> is true, false otherwise. |
| <li>For <code>CAST(CAST(NULL AS <i>type</i>) AS <i>type</i>))</code>, |
| returns false. |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNull(org.apache.calcite.sql.SqlNode)"> |
| <h3>isNull</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isNull</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| <div class="block">Returns whether a node represents the NULL value or a series of nested |
| <code>CAST(NULL AS type)</code> calls. For example: |
| <code>isNull(CAST(CAST(NULL as INTEGER) AS VARCHAR(1)))</code> |
| returns <code>true</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLiteral(org.apache.calcite.sql.SqlNode,boolean)"> |
| <h3>isLiteral</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isLiteral</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean allowCast)</span></div> |
| <div class="block">Returns whether a node is a literal. |
| |
| <p>Examples: |
| |
| <ul> |
| <li>For <code>CAST(literal AS <i>type</i>)</code>, returns true if <code> |
| allowCast</code> is true, false otherwise. |
| <li>For <code>CAST(CAST(literal AS <i>type</i>) AS <i>type</i>))</code>, |
| returns false. |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - The node, never null.</dd> |
| <dd><code>allowCast</code> - whether to regard CAST(literal) as a literal</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the node is a literal</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLiteral(org.apache.calcite.sql.SqlNode)"> |
| <h3>isLiteral</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isLiteral</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| <div class="block">Returns whether a node is a literal. |
| |
| <p>Many constructs which require literals also accept <code>CAST(NULL AS |
| <i>type</i>)</code>. This method does not accept casts, so you should |
| call <a href="#isNullLiteral(org.apache.calcite.sql.SqlNode,boolean)"><code>isNullLiteral(org.apache.calcite.sql.SqlNode, boolean)</code></a> first.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - The node, never null.</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the node is a literal</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLiteralChain(org.apache.calcite.sql.SqlNode)"> |
| <h3>isLiteralChain</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isLiteralChain</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| <div class="block">Returns whether a node is a literal chain which is used to represent a |
| continued string literal.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - The node, never null.</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the node is a literal chain</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparseFunctionSyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall)"> |
| <h3>unparseFunctionSyntax</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">void</span> <span class="element-name">unparseFunctionSyntax</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparseFunctionSyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,boolean)"> |
| <h3>unparseFunctionSyntax</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">unparseFunctionSyntax</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| boolean ordered)</span></div> |
| <div class="block">Unparses a call to an operator that has function syntax.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>operator</code> - The operator</dd> |
| <dd><code>writer</code> - Writer</dd> |
| <dd><code>call</code> - List of 0 or more operands</dd> |
| <dd><code>ordered</code> - Whether argument list may end with ORDER BY</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparseSqlIdentifierSyntax(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlIdentifier,boolean)"> |
| <h3>unparseSqlIdentifierSyntax</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">unparseSqlIdentifierSyntax</span><wbr><span class="parameters">(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> identifier, |
| boolean asFunctionID)</span></div> |
| <div class="block">Unparse a SqlIdentifier syntax.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>writer</code> - Writer</dd> |
| <dd><code>identifier</code> - SqlIdentifier</dd> |
| <dd><code>asFunctionID</code> - Whether this identifier comes from a SqlFunction</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparseBinarySyntax(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlWriter,int,int)"> |
| <h3>unparseBinarySyntax</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">unparseBinarySyntax</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="concatenateLiterals(java.util.List)"> |
| <h3>concatenateLiterals</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a></span> <span class="element-name">concatenateLiterals</span><wbr><span class="parameters">(<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="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a>> lits)</span></div> |
| <div class="block">Concatenates string literals. |
| |
| <p>This method takes an array of arguments, since pairwise concatenation |
| means too much string copying.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>lits</code> - an array of <a href="SqlLiteral.html" title="class in org.apache.calcite.sql"><code>SqlLiteral</code></a>, not empty, all of the same |
| class</dd> |
| <dt>Returns:</dt> |
| <dd>a new <a href="SqlLiteral.html" title="class in org.apache.calcite.sql"><code>SqlLiteral</code></a>, of that same class, whose value is the |
| string concatenation of the values of the literals</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if the lits are not homogeneous.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">ArrayIndexOutOfBoundsException</a></code> - if lits is an empty array.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupRoutine(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlIdentifier,java.util.List,java.util.List,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.SqlSyntax,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.validate.SqlNameMatcher,boolean)"> |
| <h3>lookupRoutine</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@Nullable <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></span> <span class="element-name">lookupRoutine</span><wbr><span class="parameters">(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| @Nullable <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="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>> argNames, |
| @Nullable <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a> syntax, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sqlKind, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher, |
| boolean coerce)</span></div> |
| <div class="block">Looks up a (possibly overloaded) routine based on name and argument |
| types.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>opTab</code> - operator table to search</dd> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| <dd><code>funcName</code> - name of function being invoked</dd> |
| <dd><code>argTypes</code> - argument types</dd> |
| <dd><code>argNames</code> - argument names, or null if call by position</dd> |
| <dd><code>category</code> - whether a function or a procedure. (If a procedure is |
| being invoked, the overload rules are simpler.)</dd> |
| <dd><code>nameMatcher</code> - Whether to look up the function case-sensitively</dd> |
| <dd><code>coerce</code> - Whether to allow type coercion when do filter routines |
| by parameter types</dd> |
| <dt>Returns:</dt> |
| <dd>matching routine, or null if none found</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 10.4</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupSubjectRoutines(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlIdentifier,java.util.List,java.util.List,org.apache.calcite.sql.SqlSyntax,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.validate.SqlNameMatcher,boolean)"> |
| <h3>lookupSubjectRoutines</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a>></span> <span class="element-name">lookupSubjectRoutines</span><wbr><span class="parameters">(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| @Nullable <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="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>> argNames, |
| <a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a> sqlSyntax, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sqlKind, |
| @Nullable <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher, |
| boolean coerce)</span></div> |
| <div class="block">Looks up all subject routines matching the given name and argument types.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>opTab</code> - operator table to search</dd> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| <dd><code>funcName</code> - name of function being invoked</dd> |
| <dd><code>argTypes</code> - argument types</dd> |
| <dd><code>argNames</code> - argument names, or null if call by position</dd> |
| <dd><code>sqlSyntax</code> - the SqlSyntax of the SqlOperator being looked up</dd> |
| <dd><code>sqlKind</code> - the SqlKind of the SqlOperator being looked up</dd> |
| <dd><code>category</code> - Category of routine to look up</dd> |
| <dd><code>nameMatcher</code> - Whether to look up the function case-sensitively</dd> |
| <dd><code>coerce</code> - Whether to allow type coercion when do filter routine |
| by parameter types</dd> |
| <dt>Returns:</dt> |
| <dd>list of matching routines</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 10.4</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="matchRoutinesByParameterCount(org.apache.calcite.sql.SqlOperatorTable,org.apache.calcite.sql.SqlIdentifier,java.util.List,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.validate.SqlNameMatcher)"> |
| <h3>matchRoutinesByParameterCount</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">matchRoutinesByParameterCount</span><wbr><span class="parameters">(<a href="SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> funcName, |
| <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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> argTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category, |
| <a href="validate/SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher)</span></div> |
| <div class="block">Determines whether there is a routine matching the given name and number |
| of arguments.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>opTab</code> - operator table to search</dd> |
| <dd><code>funcName</code> - name of function being invoked</dd> |
| <dd><code>argTypes</code> - argument types</dd> |
| <dd><code>category</code> - category of routine to look up</dd> |
| <dd><code>nameMatcher</code> - Whether to look up the function case-sensitively</dd> |
| <dt>Returns:</dt> |
| <dd>true if match found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSelectListItem(org.apache.calcite.sql.SqlNode,int)"> |
| <h3>getSelectListItem</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getSelectListItem</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> query, |
| int i)</span></div> |
| <div class="block">Returns the <code>i</code>th select-list item of a query.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveAliasFromOrdinal(int)"> |
| <h3>deriveAliasFromOrdinal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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></span> <span class="element-name">deriveAliasFromOrdinal</span><wbr><span class="parameters">(int ordinal)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isGeneratedAlias(java.lang.String)"> |
| <h3>isGeneratedAlias</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isGeneratedAlias</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> alias)</span></div> |
| <div class="block">Whether the alias is generated by calcite.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>alias</code> - not null</dd> |
| <dt>Returns:</dt> |
| <dd>true if alias is generated by calcite, otherwise false</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperatorSignature(org.apache.calcite.sql.SqlOperator,java.util.List)"> |
| <h3>getOperatorSignature</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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></span> <span class="element-name">getOperatorSignature</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <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><?> typeList)</span></div> |
| <div class="block">Constructs an operator signature from a type list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>op</code> - operator</dd> |
| <dd><code>typeList</code> - list of types to use for operands. Types may be |
| represented as <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"><code>String</code></a>, <a href="type/SqlTypeFamily.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeFamily</code></a>, or |
| any object with a valid <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"><code>Object.toString()</code></a> method.</dd> |
| <dt>Returns:</dt> |
| <dd>constructed signature</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAliasedSignature(org.apache.calcite.sql.SqlOperator,java.lang.String,java.util.List)"> |
| <h3>getAliasedSignature</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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></span> <span class="element-name">getAliasedSignature</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <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> opName, |
| <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><?> typeList)</span></div> |
| <div class="block">Constructs an operator signature from a type list, substituting an alias |
| for the operator name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>op</code> - operator</dd> |
| <dd><code>opName</code> - name to use for operator</dd> |
| <dd><code>typeList</code> - list of <a href="type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeName</code></a> or <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"><code>String</code></a> to use for |
| operands</dd> |
| <dt>Returns:</dt> |
| <dd>constructed signature</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newContextException(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.runtime.Resources.ExInst,java.lang.String)"> |
| <h3>newContextException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></span> <span class="element-name">newContextException</span><wbr><span class="parameters">(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| org.apache.calcite.runtime.Resources.ExInst<?> e, |
| <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> inputText)</span></div> |
| <div class="block">Wraps an exception with context.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newContextException(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.runtime.Resources.ExInst)"> |
| <h3>newContextException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../runtime/CalciteContextException.html" title="class in org.apache.calcite.runtime">CalciteContextException</a></span> <span class="element-name">newContextException</span><wbr><span class="parameters">(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| org.apache.calcite.runtime.Resources.ExInst<?> e)</span></div> |
| <div class="block">Wraps an exception with context.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newContextException(int,int,int,int,org.apache.calcite.runtime.Resources.ExInst)"> |
| <h3>newContextException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../runtime/CalciteContextException.html" title="class in org.apache.calcite.runtime">CalciteContextException</a></span> <span class="element-name">newContextException</span><wbr><span class="parameters">(int line, |
| int col, |
| int endLine, |
| int endCol, |
| org.apache.calcite.runtime.Resources.ExInst<?> e)</span></div> |
| <div class="block">Wraps an exception with context.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCallTo(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlOperator)"> |
| <h3>isCallTo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isCallTo</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> operator)</span></div> |
| <div class="block">Returns whether a <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>node</code></a> is a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>call</code></a> to a |
| given <a href="SqlOperator.html" title="class in org.apache.calcite.sql"><code>operator</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createNlsStringType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.util.NlsString)"> |
| <h3>createNlsStringType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">createNlsStringType</span><wbr><span class="parameters">(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../util/NlsString.html" title="class in org.apache.calcite.util">NlsString</a> str)</span></div> |
| <div class="block">Creates the type of an <a href="../util/NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a>. |
| |
| <p>The type inherits the NlsString's <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link"><code>Charset</code></a> and |
| <a href="SqlCollation.html" title="class in org.apache.calcite.sql"><code>SqlCollation</code></a>, if they are set, otherwise it gets the system |
| defaults.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| <dd><code>str</code> - String</dd> |
| <dt>Returns:</dt> |
| <dd>Type, including collation and charset</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="translateCharacterSetName(java.lang.String)"> |
| <h3>translateCharacterSetName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@Nullable <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></span> <span class="element-name">translateCharacterSetName</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> name)</span></div> |
| <div class="block">Translates a character set name from a SQL-level name into a Java-level |
| name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - SQL-level name</dd> |
| <dt>Returns:</dt> |
| <dd>Java-level name, or null if SQL-level name is unknown</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharset(java.lang.String)"> |
| <h3>getCharset</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span> <span class="element-name">getCharset</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> charsetName)</span></div> |
| <div class="block">Returns the Java-level <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link"><code>Charset</code></a> based on given SQL-level name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>charsetName</code> - Sql charset name, must not be null.</dd> |
| <dt>Returns:</dt> |
| <dd>charset, or default charset if charsetName is null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/UnsupportedCharsetException.html" title="class or interface in java.nio.charset" class="external-link">UnsupportedCharsetException</a></code> - If no support for the named charset |
| is available in this instance of the Java virtual machine</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateCharset(org.apache.calcite.avatica.util.ByteString,java.nio.charset.Charset)"> |
| <h3>validateCharset</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">validateCharset</span><wbr><span class="parameters">(org.apache.calcite.avatica.util.ByteString value, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</span></div> |
| <div class="block">Validate if value can be decoded by given charset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - nls string in byte array</dd> |
| <dd><code>charset</code> - charset</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></code> - If the given value cannot be represented in the |
| given charset</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stripAs(org.apache.calcite.sql.SqlNode)"> |
| <h3>stripAs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@PolyNull <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">stripAs</span><wbr><span class="parameters">(@PolyNull <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| <div class="block">If a node is "AS", returns the underlying expression; otherwise returns |
| the node. Returns null if and only if the node is null.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stripListAs(org.apache.calcite.sql.SqlNodeList)"> |
| <h3>stripListAs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></span> <span class="element-name">stripListAs</span><wbr><span class="parameters">(<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</span></div> |
| <div class="block">Modifies a list of nodes, removing AS from each if present.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#stripAs(org.apache.calcite.sql.SqlNode)"><code>stripAs(org.apache.calcite.sql.SqlNode)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAncestry(org.apache.calcite.sql.SqlNode,java.util.function.Predicate,java.util.function.Predicate)"> |
| <h3>getAncestry</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> <span class="element-name">getAncestry</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> root, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> predicate, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> postPredicate)</span></div> |
| <div class="block">Returns a list of ancestors of <code>predicate</code> within a given |
| <code>SqlNode</code> tree. |
| |
| <p>The first element of the list is <code>root</code>, and the last is |
| the node that matched <code>predicate</code>. Throws if no node matches.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelHint(org.apache.calcite.rel.hint.HintStrategyTable,org.apache.calcite.sql.SqlNodeList)"> |
| <h3>getRelHint</h3> |
| <div class="member-signature"><span class="modifiers">public static</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="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></span> <span class="element-name">getRelHint</span><wbr><span class="parameters">(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategies, |
| @Nullable <a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> sqlHints)</span></div> |
| <div class="block">Returns an immutable list of <a href="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint"><code>RelHint</code></a> from sql hints, with a given |
| inherit path from the root node. |
| |
| <p>The inherit path would be empty list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>hintStrategies</code> - The hint strategies to validate the sql hints</dd> |
| <dd><code>sqlHints</code> - The sql hints nodes</dd> |
| <dt>Returns:</dt> |
| <dd>the <code>RelHint</code> list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="attachRelHint(org.apache.calcite.rel.hint.HintStrategyTable,java.util.List,org.apache.calcite.rel.hint.Hintable)"> |
| <h3>attachRelHint</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">attachRelHint</span><wbr><span class="parameters">(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategies, |
| <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="../rel/hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../rel/hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a> rel)</span></div> |
| <div class="block">Attach the <code>hints</code> to <code>rel</code> with specified hint strategies.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>hintStrategies</code> - The strategies to filter the hints</dd> |
| <dd><code>hints</code> - The original hints to be attached</dd> |
| <dt>Returns:</dt> |
| <dd>A copy of <code>rel</code> if there are any hints can be attached given |
| the hint strategies, or the original node if such hints don't exist</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createCall(org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.parser.SqlParserPos,java.util.List)"> |
| <h3>createCall</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">createCall</span><wbr><span class="parameters">(<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <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="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands)</span></div> |
| <div class="block">Creates a call to an operator. |
| |
| <p>Deals with the fact the AND and OR are binary.</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> |
