| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlFunction (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: SqlFunction"> |
| <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>Nested | </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>Field | </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 SqlFunction" class="title">Class SqlFunction</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"><a href="SqlOperator.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlOperator</a> |
| <div class="inheritance">org.apache.calcite.sql.SqlFunction</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../test/MockSqlOperatorTable.BadTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.BadTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.CompositeFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.CompositeFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.DedupFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.DedupFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.DynamicTypeFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.DynamicTypeFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.InvalidTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.InvalidTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.MapFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MapFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.MyFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.NotATableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.NotATableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.RampFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.RampFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.RowFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.RowFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.ScoreTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.ScoreTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.SimilarlityTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.SimilarlityTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.SplitFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.SplitFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.StructuredFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.StructuredFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.TopNTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.TopNTableFunction</a></code>, <code><a href="fun/SqlAbstractTimeFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractTimeFunction</a></code>, <code><a href="SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a></code>, <code><a href="fun/SqlBaseContextVariable.html" title="class in org.apache.calcite.sql.fun">SqlBaseContextVariable</a></code>, <code><a href="SqlBasicFunction.html" title="class in org.apache.calcite.sql">SqlBasicFunction</a></code>, <code><a href="fun/SqlCastFunction.html" title="class in org.apache.calcite.sql.fun">SqlCastFunction</a></code>, <code><a href="fun/SqlCoalesceFunction.html" title="class in org.apache.calcite.sql.fun">SqlCoalesceFunction</a></code>, <code><a href="fun/SqlConvertFunction.html" title="class in org.apache.calcite.sql.fun">SqlConvertFunction</a></code>, <code><a href="fun/SqlCurrentDateFunction.html" title="class in org.apache.calcite.sql.fun">SqlCurrentDateFunction</a></code>, <code><a href="fun/SqlDatePartFunction.html" title="class in org.apache.calcite.sql.fun">SqlDatePartFunction</a></code>, <code><a href="fun/SqlExtractFunction.html" title="class in org.apache.calcite.sql.fun">SqlExtractFunction</a></code>, <code><a href="SqlGroupedWindowFunction.html" title="class in org.apache.calcite.sql">SqlGroupedWindowFunction</a></code>, <code><a href="SqlJdbcFunctionCall.html" title="class in org.apache.calcite.sql">SqlJdbcFunctionCall</a></code>, <code><a href="fun/SqlJsonArrayFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayFunction</a></code>, <code><a href="fun/SqlJsonDepthFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonDepthFunction</a></code>, <code><a href="fun/SqlJsonExistsFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonExistsFunction</a></code>, <code><a href="fun/SqlJsonKeysFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonKeysFunction</a></code>, <code><a href="fun/SqlJsonLengthFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonLengthFunction</a></code>, <code><a href="fun/SqlJsonModifyFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonModifyFunction</a></code>, <code><a href="fun/SqlJsonObjectFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectFunction</a></code>, <code><a href="fun/SqlJsonPrettyFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonPrettyFunction</a></code>, <code><a href="fun/SqlJsonQueryFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonQueryFunction</a></code>, <code><a href="fun/SqlJsonRemoveFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonRemoveFunction</a></code>, <code><a href="fun/SqlJsonStorageSizeFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonStorageSizeFunction</a></code>, <code><a href="fun/SqlJsonTypeFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonTypeFunction</a></code>, <code><a href="fun/SqlJsonValueFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonValueFunction</a></code>, <code><a href="SqlMatchFunction.html" title="class in org.apache.calcite.sql">SqlMatchFunction</a></code>, <code><a href="fun/SqlMonotonicUnaryFunction.html" title="class in org.apache.calcite.sql.fun">SqlMonotonicUnaryFunction</a></code>, <code><a href="fun/SqlNullifFunction.html" title="class in org.apache.calcite.sql.fun">SqlNullifFunction</a></code>, <code><a href="fun/SqlOverlayFunction.html" title="class in org.apache.calcite.sql.fun">SqlOverlayFunction</a></code>, <code><a href="fun/SqlPositionFunction.html" title="class in org.apache.calcite.sql.fun">SqlPositionFunction</a></code>, <code><a href="fun/SqlRandFunction.html" title="class in org.apache.calcite.sql.fun">SqlRandFunction</a></code>, <code><a href="fun/SqlRandIntegerFunction.html" title="class in org.apache.calcite.sql.fun">SqlRandIntegerFunction</a></code>, <code><a href="fun/SqlRegexpReplaceFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegexpReplaceFunction</a></code>, <code><a href="fun/SqlSubstringFunction.html" title="class in org.apache.calcite.sql.fun">SqlSubstringFunction</a></code>, <code><a href="fun/SqlTimestampAddFunction.html" title="class in org.apache.calcite.sql.fun">SqlTimestampAddFunction</a></code>, <code><a href="fun/SqlTranslate3Function.html" title="class in org.apache.calcite.sql.fun">SqlTranslate3Function</a></code>, <code><a href="fun/SqlTrimFunction.html" title="class in org.apache.calcite.sql.fun">SqlTrimFunction</a></code>, <code><a href="SqlTypeConstructorFunction.html" title="class in org.apache.calcite.sql">SqlTypeConstructorFunction</a></code>, <code><a href="SqlUnresolvedFunction.html" title="class in org.apache.calcite.sql">SqlUnresolvedFunction</a></code>, <code><a href="validate/SqlUserDefinedFunction.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedFunction</a></code>, <code><a href="validate/SqlUserDefinedTableMacro.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedTableMacro</a></code>, <code><a href="SqlWindowTableFunction.html" title="class in org.apache.calcite.sql">SqlWindowTableFunction</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SqlFunction</span> |
| <span class="extends-implements">extends <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></span></div> |
| <div class="block">A <code>SqlFunction</code> is a type of operator which has conventional |
| function-call syntax.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.sql.SqlOperator">Fields inherited from class org.apache.calcite.sql.<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></h3> |
| <code><a href="SqlOperator.html#kind">kind</a>, <a href="SqlOperator.html#MDX_PRECEDENCE">MDX_PRECEDENCE</a>, <a href="SqlOperator.html#NL">NL</a></code></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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,java.util.List,org.apache.calcite.sql.SqlFunctionCategory)" class="member-name-link">SqlFunction</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, |
| @Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| @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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> paramTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlFunctionCategory)" class="member-name-link">SqlFunction</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, |
| @Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Internal constructor.</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlFunctionCategory)" class="member-name-link">SqlFunction</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, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new SqlFunction for a call to a built-in function.</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,java.util.List,org.apache.calcite.sql.SqlFunctionCategory)" class="member-name-link">SqlFunction</a><wbr>(<a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| @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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> paramTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> funcType)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a placeholder SqlFunction for an invocation of a function with a |
| possibly qualified name.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)" class="member-name-link">deriveType</a><wbr>(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <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-tab2 method-summary-table-tab4"> |
| <div class="block">Derives the type of a call to this operator.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFunctionType()" class="member-name-link">getFunctionType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return function category.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNameAsId()" class="member-name-link">getNameAsId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the fully-qualified name of this operator.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="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-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getParamNames()" class="member-name-link">getParamNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>@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="../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-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getParamTypes()" class="member-name-link">getParamTypes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 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-tab2 method-summary-table-tab4"><code>@Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSqlIdentifier()" class="member-name-link">getSqlIdentifier</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the fully-qualified name of function, or null for a built-in |
| function.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSyntax()" class="member-name-link">getSyntax</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the syntactic type of this operator, never null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isQuantifierAllowed()" class="member-name-link">isQuantifierAllowed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this function allows a <code>DISTINCT</code> or <code> |
| ALL</code> quantifier.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)" class="member-name-link">unparse</a><wbr>(<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, |
| int leftPrec, |
| int rightPrec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a SQL representation of a call to this operator to a writer, |
| including parentheses if the operators on either side are of greater |
| precedence.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)" class="member-name-link">validateCall</a><wbr>(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> operandScope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validates a call to this operator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateQuantifier(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall)" class="member-name-link">validateQuantifier</a><wbr>(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <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-tab2 method-summary-table-tab4"> |
| <div class="block">Throws a validation error if a DISTINCT or ALL quantifier is present but |
| not allowed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.SqlOperator">Methods inherited from class org.apache.calcite.sql.<a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></h3> |
| <code><a href="SqlOperator.html#acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall)">acceptCall</a>, <a href="SqlOperator.html#acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall,boolean,org.apache.calcite.sql.util.SqlBasicVisitor.ArgHandler)">acceptCall</a>, <a href="SqlOperator.html#adjustType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,org.apache.calcite.rel.type.RelDataType)">adjustType</a>, <a href="SqlOperator.html#allowsFraming()">allowsFraming</a>, <a href="SqlOperator.html#argumentMustBeScalar(int)">argumentMustBeScalar</a>, <a href="SqlOperator.html#checkOperandCount(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlCall)">checkOperandCount</a>, <a href="SqlOperator.html#checkOperandTypes(org.apache.calcite.sql.SqlCallBinding,boolean)">checkOperandTypes</a>, <a href="SqlOperator.html#constructArgNameList(org.apache.calcite.sql.SqlCall)">constructArgNameList</a>, <a href="SqlOperator.html#constructArgTypeList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall,java.util.List,boolean)">constructArgTypeList</a>, <a href="SqlOperator.html#constructOperandList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,java.util.List)">constructOperandList</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.SqlLiteral,org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.SqlLiteral,org.apache.calcite.sql.parser.SqlParserPos,java.lang.Iterable)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.SqlLiteral,org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNodeList)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.parser.SqlParserPos,java.util.List)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNodeList)">createCall</a>, <a href="SqlOperator.html#createCall(org.apache.calcite.sql.SqlNodeList)">createCall</a>, <a href="SqlOperator.html#deriveOperandType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,int,org.apache.calcite.sql.SqlNode)">deriveOperandType</a>, <a href="SqlOperator.html#equals(java.lang.Object)">equals</a>, <a href="SqlOperator.html#getAllowedSignatures()">getAllowedSignatures</a>, <a href="SqlOperator.html#getAllowedSignatures(java.lang.String)">getAllowedSignatures</a>, <a href="SqlOperator.html#getKind()">getKind</a>, <a href="SqlOperator.html#getLeftPrec()">getLeftPrec</a>, <a href="SqlOperator.html#getMonotonicity(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a>, <a href="SqlOperator.html#getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding)">getMonotonicity</a>, <a href="SqlOperator.html#getName()">getName</a>, <a href="SqlOperator.html#getOperandCountRange()">getOperandCountRange</a>, <a href="SqlOperator.html#getOperandTypeChecker()">getOperandTypeChecker</a>, <a href="SqlOperator.html#getOperandTypeInference()">getOperandTypeInference</a>, <a href="SqlOperator.html#getReturnTypeInference()">getReturnTypeInference</a>, <a href="SqlOperator.html#getRightPrec()">getRightPrec</a>, <a href="SqlOperator.html#getSignatureTemplate(int)">getSignatureTemplate</a>, <a href="SqlOperator.html#getStrongPolicyInference()">getStrongPolicyInference</a>, <a href="SqlOperator.html#hashCode()">hashCode</a>, <a href="SqlOperator.html#inferReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,java.util.List)">inferReturnType</a>, <a href="SqlOperator.html#inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)">inferReturnType</a>, <a href="SqlOperator.html#isAggregator()">isAggregator</a>, <a href="SqlOperator.html#isDeterministic()">isDeterministic</a>, <a href="SqlOperator.html#isDynamicFunction()">isDynamicFunction</a>, <a href="SqlOperator.html#isGroup()">isGroup</a>, <a href="SqlOperator.html#isGroupAuxiliary()">isGroupAuxiliary</a>, <a href="SqlOperator.html#isName(java.lang.String,boolean)">isName</a>, <a href="SqlOperator.html#isSymmetrical()">isSymmetrical</a>, <a href="SqlOperator.html#leftPrec(int,boolean)">leftPrec</a>, <a href="SqlOperator.html#not()">not</a>, <a href="SqlOperator.html#preValidateCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">preValidateCall</a>, <a href="SqlOperator.html#requiresDecimalExpansion()">requiresDecimalExpansion</a>, <a href="SqlOperator.html#requiresOrder()">requiresOrder</a>, <a href="SqlOperator.html#requiresOver()">requiresOver</a>, <a href="SqlOperator.html#reverse()">reverse</a>, <a href="SqlOperator.html#rewriteCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall)">rewriteCall</a>, <a href="SqlOperator.html#rightPrec(int,boolean)">rightPrec</a>, <a href="SqlOperator.html#toString()">toString</a>, <a href="SqlOperator.html#unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode)">unparseListClause</a>, <a href="SqlOperator.html#unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlKind)">unparseListClause</a>, <a href="SqlOperator.html#validateOperands(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">validateOperands</a>, <a href="SqlOperator.html#validRexOperands(int,org.apache.calcite.util.Litmus)">validRexOperands</a></code></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#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#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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlFunctionCategory)"> |
| <h3>SqlFunction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlFunction</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, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</span></div> |
| <div class="block">Creates a new SqlFunction for a call to a built-in function.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Name of built-in function</dd> |
| <dd><code>kind</code> - kind of operator implemented by function</dd> |
| <dd><code>returnTypeInference</code> - strategy to use for return type inference</dd> |
| <dd><code>operandTypeInference</code> - strategy to use for parameter type inference</dd> |
| <dd><code>operandTypeChecker</code> - strategy to use for parameter type checking</dd> |
| <dd><code>category</code> - categorization for function</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,java.util.List,org.apache.calcite.sql.SqlFunctionCategory)"> |
| <h3>SqlFunction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlFunction</span><wbr><span class="parameters">(<a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| @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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> paramTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> funcType)</span></div> |
| <div class="block">Creates a placeholder SqlFunction for an invocation of a function with a |
| possibly qualified name. This name must be resolved into either a built-in |
| function or a user-defined function.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sqlIdentifier</code> - possibly qualified identifier for function</dd> |
| <dd><code>returnTypeInference</code> - strategy to use for return type inference</dd> |
| <dd><code>operandTypeInference</code> - strategy to use for parameter type inference</dd> |
| <dd><code>operandTypeChecker</code> - strategy to use for parameter type checking</dd> |
| <dd><code>paramTypes</code> - array of parameter types</dd> |
| <dd><code>funcType</code> - function category</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,java.util.List,org.apache.calcite.sql.SqlFunctionCategory)"> |
| <h3>SqlFunction</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">protected</span> <span class="element-name">SqlFunction</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, |
| @Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| @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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> paramTypes, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlKind,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlFunctionCategory)"> |
| <h3>SqlFunction</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">SqlFunction</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, |
| @Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> sqlIdentifier, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| @Nullable <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| @Nullable <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| @Nullable <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker, |
| <a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a> category)</span></div> |
| <div class="block">Internal constructor.</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="getSyntax()"> |
| <h3>getSyntax</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a></span> <span class="element-name">getSyntax</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SqlOperator.html#getSyntax()">SqlOperator</a></code></span></div> |
| <div class="block">Returns the syntactic type of this operator, never null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlOperator.html#getSyntax()">getSyntax</a></code> in class <code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSqlIdentifier()"> |
| <h3>getSqlIdentifier</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="element-name">getSqlIdentifier</span>()</div> |
| <div class="block">Returns the fully-qualified name of function, or null for a built-in |
| function.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNameAsId()"> |
| <h3>getNameAsId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="element-name">getNameAsId</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SqlOperator.html#getNameAsId()">SqlOperator</a></code></span></div> |
| <div class="block">Returns the fully-qualified name of this operator.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SqlOperator.html#getNameAsId()">getNameAsId</a></code> in class <code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParamTypes()"> |
| <h3>getParamTypes</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</span> <span class="return-type">@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="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>></span> <span class="element-name">getParamTypes</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Use <a href="type/SqlOperandMetadata.html#paramTypes(org.apache.calcite.rel.type.RelDataTypeFactory)"><code>SqlOperandMetadata.paramTypes(RelDataTypeFactory)</code></a> on the |
| result of <a href="SqlOperator.html#getOperandTypeChecker()"><code>SqlOperator.getOperandTypeChecker()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParamNames()"> |
| <h3>getParamNames</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</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="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">getParamNames</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Use <a href="type/SqlOperandMetadata.html#paramNames()"><code>SqlOperandMetadata.paramNames()</code></a> on the result of |
| <a href="SqlOperator.html#getOperandTypeChecker()"><code>SqlOperator.getOperandTypeChecker()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)"> |
| <h3>unparse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unparse</span><wbr><span class="parameters">(<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, |
| int leftPrec, |
| int rightPrec)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SqlOperator.html#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)">SqlOperator</a></code></span></div> |
| <div class="block">Writes a SQL representation of a call to this operator to a writer, |
| including parentheses if the operators on either side are of greater |
| precedence. |
| |
| <p>The default implementation of this method delegates to |
| <a href="SqlSyntax.html#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlCall,int,int)"><code>SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SqlOperator.html#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)">unparse</a></code> in class <code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFunctionType()"> |
| <h3>getFunctionType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlFunctionCategory.html" title="enum in org.apache.calcite.sql">SqlFunctionCategory</a></span> <span class="element-name">getFunctionType</span>()</div> |
| <div class="block">Return function category.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isQuantifierAllowed()"> |
| <h3>isQuantifierAllowed</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isQuantifierAllowed</span>()</div> |
| <div class="block">Returns whether this function allows a <code>DISTINCT</code> or <code> |
| ALL</code> quantifier. The default is <code>false</code>; some aggregate |
| functions return <code>true</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)"> |
| <h3>validateCall</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">validateCall</span><wbr><span class="parameters">(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> operandScope)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SqlOperator.html#validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)">SqlOperator</a></code></span></div> |
| <div class="block">Validates a call to this operator. |
| |
| <p>This method should not perform type-derivation or perform validation |
| related related to types. That is done later, by |
| <a href="SqlOperator.html#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)"><code>SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall)</code></a>. This method |
| should focus on structural validation. |
| |
| <p>A typical implementation of this method first validates the operands, |
| then performs some operator-specific logic. The default implementation |
| just validates the operands. |
| |
| <p>This method is the default implementation of <a href="SqlCall.html#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"><code>SqlCall.validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope)</code></a>; |
| but note that some sub-classes of <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a> never call this method.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SqlOperator.html#validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)">validateCall</a></code> in class <code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>call</code> - the call to this operator</dd> |
| <dd><code>validator</code> - the active validator</dd> |
| <dd><code>scope</code> - validator scope</dd> |
| <dd><code>operandScope</code> - validator scope in which to validate operands to this |
| call; usually equal to scope, but not always because |
| some operators introduce new scopes</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="SqlNode.html#validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"><code>SqlNode.validateExpr(SqlValidator, SqlValidatorScope)</code></a></li> |
| <li><a href="SqlOperator.html#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)"><code>SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateQuantifier(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall)"> |
| <h3>validateQuantifier</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">validateQuantifier</span><wbr><span class="parameters">(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Throws a validation error if a DISTINCT or ALL quantifier is present but |
| not allowed.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)"> |
| <h3>deriveType</h3> |
| <div class="member-signature"><span class="modifiers">public</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">deriveType</span><wbr><span class="parameters">(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SqlOperator.html#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">SqlOperator</a></code></span></div> |
| <div class="block">Derives the type of a call to this operator. |
| |
| <p>This method is an intrinsic part of the validation process so, unlike |
| <a href="SqlOperator.html#inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)"><code>SqlOperator.inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)</code></a>, specific operators would not typically override |
| this method.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SqlOperator.html#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">deriveType</a></code> in class <code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>validator</code> - Validator</dd> |
| <dd><code>scope</code> - Scope of validation</dd> |
| <dd><code>call</code> - Call to this operator</dd> |
| <dt>Returns:</dt> |
| <dd>Type of call</dd> |
| </dl> |
| </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> |
