Package org.apache.calcite.sql.fun
Defines the set of standard SQL rowlevel functions and
operators.
The standard set of rowlevel functions and operators are declared in
class SqlStdOperatorTable
. 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 toplevel class within this package instead. Operators
which are not rowlevel (e.g. select and join) should be defined in package
org.apache.calcite.sql
instead.

Class Summary Class Description OracleSqlOperatorTable Deprecated. UseSqlLibraryOperatorTableFactory.getOperatorTable(SqlLibrary...)
instead, passingSqlLibrary.ORACLE
as argument.SqlAbstractGroupFunction Base class for grouping functionsGROUP_ID
,GROUPING_ID
,GROUPING
.SqlAbstractTimeFunction Base class for time functions such as "LOCALTIME", "LOCALTIME(n)".SqlAnyValueAggFunction Definition of theANY_VALUE
aggregate functions, returning any one of the values which go into it.SqlArgumentAssignmentOperator Operator that assigns an argument to a function call to a particular named parameter.SqlArrayQueryConstructor Definition of the SQL:2003 standard ARRAY query constructor,ARRAY (<query>)
.SqlArrayValueConstructor Definition of the SQL:2003 standard ARRAY constructor,ARRAY [<expr>, ...]
.SqlAvgAggFunction Avg
is an aggregator which returns the average of the values which go into it.SqlBaseContextVariable Base class for functions such as "USER", "CURRENT_ROLE", and "CURRENT_PATH".SqlBetweenOperator Defines the BETWEEN operator.SqlBetweenOperator.AndFinder Finds an AND operator in an expression.SqlBitOpAggFunction Definition of theBIT_AND
andBIT_OR
aggregate functions, returning the bitwise AND/OR of all nonnull input values, or null if none.SqlCase ASqlCase
is a node of a parse tree which represents a case statement.SqlCaseOperator An operator describing aCASE
,NULLIF
orCOALESCE
expression.SqlCastFunction SqlCastFunction.SqlCastOperator Infix cast operator, "::", as used in PostgreSQL.SqlCoalesceFunction TheCOALESCE
function.SqlCollectionTableOperator SqlCollectionTableOperator is the "table function derived table" operator.SqlColumnListConstructor SqlColumnListConstructor defines the nonstandard constructor used to pass a COLUMN_LIST parameter to a UDX.SqlConvertFunction Common base for theCONVERT
andTRANSLATE
functions.SqlCountAggFunction Definition of the SQLCOUNT
aggregation function.SqlCovarAggFunction Covar
is an aggregator which returns the Covariance of the values which go into it.SqlCurrentDateFunction TheCURRENT_DATE
function.SqlCursorConstructor SqlCursorConstructor defines the nonstandard CURSOR(<query>) constructor.SqlDatePartFunction SqlDatePartFunction represents the SQL:1999 standardYEAR
,QUARTER
,MONTH
andDAY
functions.SqlDatetimePlusOperator Operator that adds an INTERVAL to a DATETIME.SqlDatetimeSubtractionOperator A special operator for the subtraction of two DATETIMEs.SqlDefaultOperator Operator that indicates that an argument to a function call is to take its default value.SqlDotOperator The dot operator.
, used to access a field of a record.SqlExtendOperator EXTEND
operator.SqlExtractFunction The SQLEXTRACT
operator.SqlFirstLastValueAggFunction FIRST_VALUE
andLAST_VALUE
aggregate functions return the first or the last value in a list of values that are input to the function.SqlFloorFunction Definition of the "FLOOR" and "CEIL" builtin SQL functions.SqlGroupIdFunction TheGROUP_ID()
function.SqlGroupingFunction TheGROUPING
function.SqlGroupingIdFunction Deprecated. Now thatGROUPING
has the same functionality, this function is deprecated.SqlHistogramAggFunction HISTOGRAM
is the base operator that supports the Histogram MIN/MAX aggregate functions.SqlInOperator Definition of the SQLIN
operator, which tests for a value's membership in a subquery or a list of values.SqlItemOperator The item operator[ ... ]
, used to access a given element of an array or map.SqlJsonArrayAggAggFunction TheJSON_OBJECTAGG
aggregate function.SqlJsonArrayFunction TheJSON_ARRAY
function.SqlJsonDepthFunction TheJSON_DEPTH
function.SqlJsonExistsFunction TheJSON_EXISTS
function.SqlJsonKeysFunction TheJSON_KEYS
function.SqlJsonLengthFunction TheJSON_LENGTH
function.SqlJsonObjectAggAggFunction TheJSON_OBJECTAGG
aggregate function.SqlJsonObjectFunction TheJSON_OBJECT
function.SqlJsonPrettyFunction TheJSON_TYPE
function.SqlJsonQueryFunction TheJSON_QUERY
function.SqlJsonRemoveFunction TheJSON_REMOVE
function.SqlJsonStorageSizeFunction TheJSON_STORAGE_SIZE
function.SqlJsonTypeFunction TheJSON_TYPE
function.SqlJsonValueExpressionOperator The JSON value expression operator that indicates that the value expression should be parsed as JSON.SqlJsonValueFunction TheJSON_VALUE
function.SqlLeadLagAggFunction LEAD
andLAG
aggregate functions return the value of given expression evaluated at given offset.SqlLibraryOperators Defines functions and operators that are not part of standard SQL but belong to one or more other dialects of SQL.SqlLibraryOperatorTableFactory Factory that creates operator tables that consist of functions and operators for particular named libraries.SqlLikeOperator An operator describing theLIKE
andSIMILAR
operators.SqlLiteralChainOperator Internal operator, by which the parser represents a continued string literal.SqlMapQueryConstructor Definition of the MAP query constructor,MAP (<query>)
.SqlMapValueConstructor Definition of the MAP constructor,MAP [<key>, <value>, ...]
.SqlMinMaxAggFunction Definition of theMIN
andMAX
aggregate functions, returning the returns the smallest/largest of the values which go into it.SqlMonotonicBinaryOperator Base class for binary operators such as addition, subtraction, and multiplication which are monotonic for the patternsm op c
andc op m
where m is any monotonic expression and c is a constant.SqlMonotonicUnaryFunction Base class for unary operators such as FLOOR/CEIL which are monotonic for monotonic inputs.SqlMultisetMemberOfOperator Multiset MEMBER OF.SqlMultisetQueryConstructor Definition of the SQL:2003 standard MULTISET query constructor,MULTISET (<query>)
.SqlMultisetSetOperator An operator which performs set operations on multisets, such as "MULTISET UNION ALL".SqlMultisetValueConstructor Definition of the SQL:2003 standard MULTISET constructor,MULTISET [<expr>, ...]
.SqlNewOperator SqlNewOperator represents an SQLnew specification
such asNEW UDT(1, 2)
.SqlNthValueAggFunction NTH_VALUE
windowed aggregate function returns the value of an expression evaluated at then
th row of the window frame.SqlNtileAggFunction NTILE
aggregate function return the value of given expression evaluated at given offset.SqlNullifFunction TheNULLIF
function.SqlOverlapsOperator SqlOverlapsOperator represents the SQL:1999 standardOVERLAPS
function.SqlOverlayFunction TheOVERLAY
function.SqlPositionFunction ThePOSITION
function.SqlPosixRegexOperator An operator describing the~
operator.SqlQuantifyOperator Definition of the SQLALL
andSOME
operators.SqlRandFunction TheRAND
function.SqlRandIntegerFunction TheRAND_INTEGER
function.SqlRegexpReplaceFunction 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.SqlRegrCountAggFunction Definition of the SQLREGR_COUNT
aggregation function.SqlRollupOperator Operator that appears in aGROUP BY
clause:CUBE
,ROLLUP
,GROUPING SETS
.SqlRowOperator SqlRowOperator represents the special ROW constructor.SqlSequenceValueOperator Operator that returns the current or next value of a sequence.SqlSingleValueAggFunction SINGLE_VALUE
aggregate function returns the input value if there is only one value in the input; Otherwise it triggers a runtime error.SqlStdOperatorTable Implementation ofSqlOperatorTable
containing the standard operators and functions.SqlStringContextVariable Base class for string functions such as "USER", "CURRENT_ROLE", and "CURRENT_PATH".SqlSubstringFunction Definition of the "SUBSTRING" builtin SQL function.SqlSumAggFunction Sum
is an aggregator which returns the sum of the values which go into it.SqlSumEmptyIsZeroAggFunction Sum0
is an aggregator which returns the sum of the values which go into it likeSum
.SqlThrowOperator An internal operator that throws an exception.SqlTimestampAddFunction TheTIMESTAMPADD
function, which adds an interval to a datetime (TIMESTAMP, TIME or DATE).SqlTimestampDiffFunction TheTIMESTAMPDIFF
function, which calculates the difference between two timestamps.SqlTranslate3Function Definition of the "TRANSLATE" builtin SQL function that takes 3 arguments.SqlTrimFunction Definition of the "TRIM" builtin SQL function. 
Enum Summary Enum Description SqlAvgAggFunction.Subtype Deprecated. SqlBetweenOperator.Flag Defines the "SYMMETRIC" and "ASYMMETRIC" keywords.SqlCovarAggFunction.Subtype Deprecated. SqlLibrary A library is a collection of SQL functions and operators.SqlTrimFunction.Flag Defines the enumerated values "LEADING", "TRAILING", "BOTH". 
Annotation Types Summary Annotation Type Description LibraryOperator An annotation that is read bySqlLibraryOperatorTableFactory
to add functions and operators to a library.