| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.sql.fun (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.calcite.sql.fun (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.sql.fun</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Defines the set of standard SQL row-level functions and |
| operators. |
| |
| <p>The standard set of row-level functions and operators are declared in |
| class <a href="SqlStdOperatorTable.html" title="class in org.apache.calcite.sql.fun"><code>SqlStdOperatorTable</code></a>. Anonymous inner |
| classes within that table are allowed only for specifying an operator's test |
| function; if other custom code is needed for an operator, it should be |
| implemented in a top-level class within this package instead. Operators |
| which are not row-level (e.g. select and join) should be defined in package |
| <a href="../package-summary.html"><code>org.apache.calcite.sql</code></a> instead.</p></div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="OracleSqlOperatorTable.html" title="class in org.apache.calcite.sql.fun">OracleSqlOperatorTable</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">Use |
| <a href="SqlLibraryOperatorTableFactory.html#getOperatorTable(org.apache.calcite.sql.fun.SqlLibrary...)"><code>SqlLibraryOperatorTableFactory.getOperatorTable(SqlLibrary...)</code></a> |
| instead, passing <a href="SqlLibrary.html#ORACLE"><code>SqlLibrary.ORACLE</code></a> as argument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlAbstractGroupFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractGroupFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for grouping functions <code>GROUP_ID</code>, <code>GROUPING_ID</code>, |
| <code>GROUPING</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlAbstractTimeFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractTimeFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for time functions such as "LOCALTIME", "LOCALTIME(n)".</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlAnyValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAnyValueAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the <code>ANY_VALUE</code> aggregate functions, |
| returning any one of the values which go into it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlArgumentAssignmentOperator.html" title="class in org.apache.calcite.sql.fun">SqlArgumentAssignmentOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Operator that assigns an argument to a function call to a particular named |
| parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlArrayQueryConstructor.html" title="class in org.apache.calcite.sql.fun">SqlArrayQueryConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL:2003 standard ARRAY query constructor, <code> |
| ARRAY (<query>)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlArrayValueConstructor.html" title="class in org.apache.calcite.sql.fun">SqlArrayValueConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL:2003 standard ARRAY constructor, <code>ARRAY |
| [<expr>, ...]</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlAvgAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAvgAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>Avg</code> is an aggregator which returns the average of the values |
| which go into it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlBaseContextVariable.html" title="class in org.apache.calcite.sql.fun">SqlBaseContextVariable</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for functions such as "USER", "CURRENT_ROLE", and "CURRENT_PATH".</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlBetweenOperator.html" title="class in org.apache.calcite.sql.fun">SqlBetweenOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the BETWEEN operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlBetweenOperator.AndFinder.html" title="class in org.apache.calcite.sql.fun">SqlBetweenOperator.AndFinder</a></th> |
| <td class="colLast"> |
| <div class="block">Finds an AND operator in an expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlBitOpAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBitOpAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the <code>BIT_AND</code> and <code>BIT_OR</code> aggregate functions, |
| returning the bitwise AND/OR of all non-null input values, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCase.html" title="class in org.apache.calcite.sql.fun">SqlCase</a></th> |
| <td class="colLast"> |
| <div class="block">A <code>SqlCase</code> is a node of a parse tree which represents a case |
| statement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlCaseOperator.html" title="class in org.apache.calcite.sql.fun">SqlCaseOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An operator describing a <code>CASE</code>, <code>NULLIF</code> or <code> |
| COALESCE</code> expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCastFunction.html" title="class in org.apache.calcite.sql.fun">SqlCastFunction</a></th> |
| <td class="colLast"> |
| <div class="block">SqlCastFunction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlCastOperator.html" title="class in org.apache.calcite.sql.fun">SqlCastOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Infix cast operator, "::", as used in PostgreSQL.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCoalesceFunction.html" title="class in org.apache.calcite.sql.fun">SqlCoalesceFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>COALESCE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlCollectionTableOperator.html" title="class in org.apache.calcite.sql.fun">SqlCollectionTableOperator</a></th> |
| <td class="colLast"> |
| <div class="block">SqlCollectionTableOperator is the "table function derived table" operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlColumnListConstructor.html" title="class in org.apache.calcite.sql.fun">SqlColumnListConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">SqlColumnListConstructor defines the non-standard constructor used to pass a |
| COLUMN_LIST parameter to a UDX.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlConvertFunction.html" title="class in org.apache.calcite.sql.fun">SqlConvertFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Common base for the <code>CONVERT</code> and <code>TRANSLATE</code> |
| functions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCountAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL <code>COUNT</code> aggregation function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlCovarAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCovarAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>Covar</code> is an aggregator which returns the Covariance of the |
| values which go into it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCurrentDateFunction.html" title="class in org.apache.calcite.sql.fun">SqlCurrentDateFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>CURRENT_DATE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlCursorConstructor.html" title="class in org.apache.calcite.sql.fun">SqlCursorConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">SqlCursorConstructor defines the non-standard CURSOR(<query>) |
| constructor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlDatePartFunction.html" title="class in org.apache.calcite.sql.fun">SqlDatePartFunction</a></th> |
| <td class="colLast"> |
| <div class="block">SqlDatePartFunction represents the SQL:1999 standard <code>YEAR</code>, |
| <code>QUARTER</code>, <code>MONTH</code> and <code>DAY</code> functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlDatetimePlusOperator.html" title="class in org.apache.calcite.sql.fun">SqlDatetimePlusOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Operator that adds an INTERVAL to a DATETIME.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlDatetimeSubtractionOperator.html" title="class in org.apache.calcite.sql.fun">SqlDatetimeSubtractionOperator</a></th> |
| <td class="colLast"> |
| <div class="block">A special operator for the subtraction of two DATETIMEs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlDefaultOperator.html" title="class in org.apache.calcite.sql.fun">SqlDefaultOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Operator that indicates that an argument to a function call is to take its |
| default value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlDotOperator.html" title="class in org.apache.calcite.sql.fun">SqlDotOperator</a></th> |
| <td class="colLast"> |
| <div class="block">The dot operator <code>.</code>, used to access a field of a |
| record.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlExtendOperator.html" title="class in org.apache.calcite.sql.fun">SqlExtendOperator</a></th> |
| <td class="colLast"> |
| <div class="block"><code>EXTEND</code> operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlExtractFunction.html" title="class in org.apache.calcite.sql.fun">SqlExtractFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The SQL <code>EXTRACT</code> operator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlFirstLastValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlFirstLastValueAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>FIRST_VALUE</code> and <code>LAST_VALUE</code> aggregate functions |
| return the first or the last value in a list of values that are input to the |
| function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlFloorFunction.html" title="class in org.apache.calcite.sql.fun">SqlFloorFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the "FLOOR" and "CEIL" built-in SQL functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlGroupIdFunction.html" title="class in org.apache.calcite.sql.fun">SqlGroupIdFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>GROUP_ID()</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlGroupingFunction.html" title="class in org.apache.calcite.sql.fun">SqlGroupingFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>GROUPING</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlGroupingIdFunction.html" title="class in org.apache.calcite.sql.fun">SqlGroupingIdFunction</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">Now that <code>GROUPING</code> has the same functionality, |
| this function is deprecated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlHistogramAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlHistogramAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>HISTOGRAM</code> is the base operator that supports the Histogram |
| MIN/MAX aggregate functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlInOperator.html" title="class in org.apache.calcite.sql.fun">SqlInOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL <code>IN</code> operator, which tests for a value's |
| membership in a sub-query or a list of values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlItemOperator.html" title="class in org.apache.calcite.sql.fun">SqlItemOperator</a></th> |
| <td class="colLast"> |
| <div class="block">The item operator <code>[ ... ]</code>, used to access a given element of an |
| array or map.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonArrayAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayAggAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_OBJECTAGG</code> aggregate function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonArrayFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_ARRAY</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonDepthFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonDepthFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_DEPTH</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonExistsFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonExistsFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_EXISTS</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonKeysFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonKeysFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_KEYS</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonLengthFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonLengthFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_LENGTH</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonObjectAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectAggAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_OBJECTAGG</code> aggregate function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonObjectFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_OBJECT</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonPrettyFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonPrettyFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_TYPE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonQueryFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonQueryFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_QUERY</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonRemoveFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonRemoveFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_REMOVE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonStorageSizeFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonStorageSizeFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_STORAGE_SIZE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonTypeFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonTypeFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_TYPE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonValueExpressionOperator.html" title="class in org.apache.calcite.sql.fun">SqlJsonValueExpressionOperator</a></th> |
| <td class="colLast"> |
| <div class="block">The JSON value expression operator that indicates that the value expression |
| should be parsed as JSON.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlJsonValueFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonValueFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JSON_VALUE</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlLeadLagAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlLeadLagAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>LEAD</code> and <code>LAG</code> aggregate functions |
| return the value of given expression evaluated at given offset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlLibraryOperators.html" title="class in org.apache.calcite.sql.fun">SqlLibraryOperators</a></th> |
| <td class="colLast"> |
| <div class="block">Defines functions and operators that are not part of standard SQL but |
| belong to one or more other dialects of SQL.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun">SqlLibraryOperatorTableFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory that creates operator tables that consist of functions and operators |
| for particular named libraries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlLikeOperator.html" title="class in org.apache.calcite.sql.fun">SqlLikeOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An operator describing the <code>LIKE</code> and <code>SIMILAR</code> |
| operators.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlLiteralChainOperator.html" title="class in org.apache.calcite.sql.fun">SqlLiteralChainOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Internal operator, by which the parser represents a continued string literal.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlMapQueryConstructor.html" title="class in org.apache.calcite.sql.fun">SqlMapQueryConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the MAP query constructor, <code> |
| MAP (<query>)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlMapValueConstructor.html" title="class in org.apache.calcite.sql.fun">SqlMapValueConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the MAP constructor, |
| <code>MAP [<key>, <value>, ...]</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlMinMaxAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlMinMaxAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the <code>MIN</code> and <code>MAX</code> aggregate functions, |
| returning the returns the smallest/largest of the values which go into it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlMonotonicBinaryOperator.html" title="class in org.apache.calcite.sql.fun">SqlMonotonicBinaryOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for binary operators such as addition, subtraction, and |
| multiplication which are monotonic for the patterns <code>m op c</code> and |
| <code>c op m</code> where m is any monotonic expression and c is a constant.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlMonotonicUnaryFunction.html" title="class in org.apache.calcite.sql.fun">SqlMonotonicUnaryFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for unary operators such as FLOOR/CEIL which are monotonic for |
| monotonic inputs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlMultisetMemberOfOperator.html" title="class in org.apache.calcite.sql.fun">SqlMultisetMemberOfOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Multiset MEMBER OF.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlMultisetQueryConstructor.html" title="class in org.apache.calcite.sql.fun">SqlMultisetQueryConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL:2003 standard MULTISET query constructor, <code> |
| MULTISET (<query>)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlMultisetSetOperator.html" title="class in org.apache.calcite.sql.fun">SqlMultisetSetOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An operator which performs set operations on multisets, such as "MULTISET |
| UNION ALL".</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlMultisetValueConstructor.html" title="class in org.apache.calcite.sql.fun">SqlMultisetValueConstructor</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL:2003 standard MULTISET constructor, <code>MULTISET |
| [<expr>, ...]</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlNewOperator.html" title="class in org.apache.calcite.sql.fun">SqlNewOperator</a></th> |
| <td class="colLast"> |
| <div class="block">SqlNewOperator represents an SQL <code>new specification</code> such as |
| <code>NEW UDT(1, 2)</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlNthValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNthValueAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>NTH_VALUE</code> windowed aggregate function |
| returns the value of an expression evaluated at the <code>n</code>th row of the |
| window frame.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlNtileAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNtileAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>NTILE</code> aggregate function |
| return the value of given expression evaluated at given offset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlNullifFunction.html" title="class in org.apache.calcite.sql.fun">SqlNullifFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>NULLIF</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlOverlapsOperator.html" title="class in org.apache.calcite.sql.fun">SqlOverlapsOperator</a></th> |
| <td class="colLast"> |
| <div class="block">SqlOverlapsOperator represents the SQL:1999 standard <code>OVERLAPS</code> |
| function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlOverlayFunction.html" title="class in org.apache.calcite.sql.fun">SqlOverlayFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>OVERLAY</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlPositionFunction.html" title="class in org.apache.calcite.sql.fun">SqlPositionFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>POSITION</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlPosixRegexOperator.html" title="class in org.apache.calcite.sql.fun">SqlPosixRegexOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An operator describing the <code>~</code> operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlQuantifyOperator.html" title="class in org.apache.calcite.sql.fun">SqlQuantifyOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL <code>ALL</code> and <code>SOME</code>operators.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlRandFunction.html" title="class in org.apache.calcite.sql.fun">SqlRandFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>RAND</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlRandIntegerFunction.html" title="class in org.apache.calcite.sql.fun">SqlRandIntegerFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>RAND_INTEGER</code> function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlRegexpReplaceFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegexpReplaceFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The REGEXP_REPLACE(source_string, pattern, replacement [, pos, occurrence, match_type]) |
| searches for a regular expression pattern and replaces every occurrence of the pattern |
| with the specified string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlRegrCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegrCountAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the SQL <code>REGR_COUNT</code> aggregation function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlRollupOperator.html" title="class in org.apache.calcite.sql.fun">SqlRollupOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Operator that appears in a <code>GROUP BY</code> clause: <code>CUBE</code>, |
| <code>ROLLUP</code>, <code>GROUPING SETS</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlRowOperator.html" title="class in org.apache.calcite.sql.fun">SqlRowOperator</a></th> |
| <td class="colLast"> |
| <div class="block">SqlRowOperator represents the special ROW constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlSequenceValueOperator.html" title="class in org.apache.calcite.sql.fun">SqlSequenceValueOperator</a></th> |
| <td class="colLast"> |
| <div class="block">Operator that returns the current or next value of a sequence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlSingleValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSingleValueAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>SINGLE_VALUE</code> aggregate function returns the input value if there |
| is only one value in the input; Otherwise it triggers a run-time error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlStdOperatorTable.html" title="class in org.apache.calcite.sql.fun">SqlStdOperatorTable</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../SqlOperatorTable.html" title="interface in org.apache.calcite.sql"><code>SqlOperatorTable</code></a> containing |
| the standard operators and functions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlStringContextVariable.html" title="class in org.apache.calcite.sql.fun">SqlStringContextVariable</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for string functions such as "USER", "CURRENT_ROLE", and |
| "CURRENT_PATH".</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlSubstringFunction.html" title="class in org.apache.calcite.sql.fun">SqlSubstringFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the "SUBSTRING" builtin SQL function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlSumAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>Sum</code> is an aggregator which returns the sum of the values which |
| go into it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlSumEmptyIsZeroAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumEmptyIsZeroAggFunction</a></th> |
| <td class="colLast"> |
| <div class="block"><code>Sum0</code> is an aggregator which returns the sum of the values which |
| go into it like <code>Sum</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlThrowOperator.html" title="class in org.apache.calcite.sql.fun">SqlThrowOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An internal operator that throws an exception.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlTimestampAddFunction.html" title="class in org.apache.calcite.sql.fun">SqlTimestampAddFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>TIMESTAMPADD</code> function, which adds an interval to a |
| datetime (TIMESTAMP, TIME or DATE).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlTimestampDiffFunction.html" title="class in org.apache.calcite.sql.fun">SqlTimestampDiffFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>TIMESTAMPDIFF</code> function, which calculates the difference |
| between two timestamps.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlTranslate3Function.html" title="class in org.apache.calcite.sql.fun">SqlTranslate3Function</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the "TRANSLATE" built-in SQL function that takes 3 arguments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlTrimFunction.html" title="class in org.apache.calcite.sql.fun">SqlTrimFunction</a></th> |
| <td class="colLast"> |
| <div class="block">Definition of the "TRIM" builtin SQL function.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlAvgAggFunction.Subtype.html" title="enum in org.apache.calcite.sql.fun">SqlAvgAggFunction.Subtype</a></th> |
| <td class="colLast">Deprecated.</td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlBetweenOperator.Flag.html" title="enum in org.apache.calcite.sql.fun">SqlBetweenOperator.Flag</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the "SYMMETRIC" and "ASYMMETRIC" keywords.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlCovarAggFunction.Subtype.html" title="enum in org.apache.calcite.sql.fun">SqlCovarAggFunction.Subtype</a></th> |
| <td class="colLast">Deprecated.</td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a></th> |
| <td class="colLast"> |
| <div class="block">A library is a collection of SQL functions and operators.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SqlTrimFunction.Flag.html" title="enum in org.apache.calcite.sql.fun">SqlTrimFunction.Flag</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the enumerated values "LEADING", "TRAILING", "BOTH".</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="LibraryOperator.html" title="annotation in org.apache.calcite.sql.fun">LibraryOperator</a></th> |
| <td class="colLast"> |
| <div class="block">An annotation that is read by <a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun"><code>SqlLibraryOperatorTableFactory</code></a> to |
| add functions and operators to a library.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
