org.apache.calcite.sql.fun (Apache Calcite API)

Class Summary
Class	Description
OracleSqlOperatorTable	Deprecated Use `SqlLibraryOperatorTableFactory.getOperatorTable(SqlLibrary...)` instead, passing `SqlLibrary.ORACLE` as argument.
SqlAbstractGroupFunction	Base class for grouping functions `GROUP_ID`, `GROUPING_ID`, `GROUPING`.
SqlAbstractTimeFunction	Base class for time functions such as "LOCALTIME", "LOCALTIME(n)".
SqlAnyValueAggFunction	Definition of the `ANY_VALUE` aggregate functions, returning any one of the values which go into it.
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".
SqlBasicAggFunction	Concrete implementation of `SqlAggFunction`.
SqlBetweenOperator	Defines the BETWEEN operator.
SqlBitOpAggFunction	Definition of the `BIT_AND` and `BIT_OR` aggregate functions, returning the bitwise AND/OR of all non-null input values, or null if none.
SqlCase	A `SqlCase` is a node of a parse tree which represents a case statement.
SqlCaseOperator	An operator describing a `CASE`, `NULLIF` or `COALESCE` expression.
SqlCastFunction	SqlCastFunction.
SqlCoalesceFunction	The `COALESCE` function.
SqlCollectionTableOperator	SqlCollectionTableOperator is the "table function derived table" operator.
SqlColumnListConstructor	SqlColumnListConstructor defines the non-standard constructor used to pass a COLUMN_LIST parameter to a UDX.
SqlConvertFunction	Common base for the `CONVERT` and `TRANSLATE` functions.
SqlCountAggFunction	Definition of the SQL `COUNT` aggregation function.
SqlCovarAggFunction	`Covar` is an aggregator which returns the Covariance of the values which go into it.
SqlCurrentDateFunction	The `CURRENT_DATE` function.
SqlCursorConstructor	SqlCursorConstructor defines the non-standard CURSOR(<query>) constructor.
SqlDatePartFunction	SqlDatePartFunction represents the SQL:1999 standard `YEAR`, `QUARTER`, `MONTH` and `DAY` functions.
SqlDatetimePlusOperator	Operator that adds an INTERVAL to a DATETIME.
SqlDatetimeSubtractionOperator	A special operator for the subtraction of two DATETIMEs.
SqlDotOperator	The dot operator `.`, used to access a field of a record.
SqlExtractFunction	The SQL `EXTRACT` operator.
SqlFirstLastValueAggFunction	`FIRST_VALUE` and `LAST_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" built-in SQL functions.
SqlHistogramAggFunction	`HISTOGRAM` is the base operator that supports the Histogram MIN/MAX aggregate functions.
SqlInOperator	Definition of the SQL `IN` operator, which tests for a value's membership in a sub-query or a list of values.
SqlInternalOperators	Contains internal operators.
SqlIntervalOperator	Interval expression.
SqlJsonArrayAggAggFunction	The `JSON_OBJECTAGG` aggregate function.
SqlJsonArrayFunction	The `JSON_ARRAY` function.
SqlJsonDepthFunction	The `JSON_DEPTH` function.
SqlJsonExistsFunction	The `JSON_EXISTS` function.
SqlJsonKeysFunction	The `JSON_KEYS` function.
SqlJsonLengthFunction	The `JSON_LENGTH` function.
SqlJsonObjectAggAggFunction	The `JSON_OBJECTAGG` aggregate function.
SqlJsonObjectFunction	The `JSON_OBJECT` function.
SqlJsonPrettyFunction	The `JSON_TYPE` function.
SqlJsonQueryFunction	The `JSON_QUERY` function.
SqlJsonRemoveFunction	The `JSON_REMOVE` function.
SqlJsonStorageSizeFunction	The `JSON_STORAGE_SIZE` function.
SqlJsonTypeFunction	The `JSON_TYPE` function.
SqlJsonValueExpressionOperator	The JSON value expression operator that indicates that the value expression should be parsed as JSON.
SqlJsonValueFunction	The `JSON_VALUE` function.
SqlLeadLagAggFunction	`LEAD` and `LAG` 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 the `LIKE` and `SIMILAR` 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 the `MIN` and `MAX` 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 patterns `m op c` and `c 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 SQL `new specification` such as `NEW UDT(1, 2)`.
SqlNthValueAggFunction	`NTH_VALUE` windowed aggregate function returns the value of an expression evaluated at the `n`th row of the window frame.
SqlNtileAggFunction	`NTILE` aggregate function return the value of given expression evaluated at given offset.
SqlNullifFunction	The `NULLIF` function.
SqlOverlapsOperator	SqlOverlapsOperator represents the SQL:1999 standard `OVERLAPS` function.
SqlOverlayFunction	The `OVERLAY` function.
SqlPositionFunction	The `POSITION` function.
SqlPosixRegexOperator	An operator describing the `~` operator.
SqlQuantifyOperator	Definition of the SQL `ALL` and `SOME`operators.
SqlRandFunction	The `RAND` function.
SqlRandIntegerFunction	The `RAND_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 SQL `REGR_COUNT` aggregation function.
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 run-time error.
SqlSpatialTypeFunctions	Utilities for spatial type functions.
SqlSpatialTypeFunctions.GridTable	Returns the points or rectangles in a grid that covers a given geometry.
SqlStdOperatorTable	Implementation of `SqlOperatorTable` 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 like `Sum`.
SqlThrowOperator	An internal operator that throws an exception.
SqlTimestampAddFunction	The `TIMESTAMPADD` function, which adds an interval to a datetime (TIMESTAMP, TIME or DATE).
SqlTranslate3Function	Definition of the "TRANSLATE" built-in 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 by SqlLibraryOperatorTableFactory to add functions and operators to a library.

Annotation Types Summary
Annotation Type	Description
LibraryOperator	An annotation that is read by `SqlLibraryOperatorTableFactory` to add functions and operators to a library.

Package org.apache.calcite.sql.fun Description

Defines the set of standard SQL row-level functions and operators.

The standard set of row-level 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 top-level class within this package instead. Operators which are not row-level (e.g. select and join) should be defined in package org.apache.calcite.sql instead.