Package org.apache.calcite.sql

Class SqlFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

Direct Known Subclasses:

MockSqlOperatorTable.BadTableFunction, MockSqlOperatorTable.CompareStringsOrNumericValues, MockSqlOperatorTable.CompositeFunction, MockSqlOperatorTable.DedupFunction, MockSqlOperatorTable.DynamicTypeFunction, MockSqlOperatorTable.InvalidTableFunction, MockSqlOperatorTable.MapFunction, MockSqlOperatorTable.MyFunction, MockSqlOperatorTable.NotATableFunction, MockSqlOperatorTable.RampFunction, MockSqlOperatorTable.RowFunction, MockSqlOperatorTable.ScoreTableFunction, MockSqlOperatorTable.SimilarlityTableFunction, MockSqlOperatorTable.SplitFunction, MockSqlOperatorTable.StructuredFunction, MockSqlOperatorTable.TableFunctionReturnTableFunction, MockSqlOperatorTable.TopNTableFunction, SqlAbstractTimeFunction, SqlAggFunction, SqlBaseContextVariable, SqlBasicFunction, SqlCastFunction, SqlCoalesceFunction, SqlConvertFunction, SqlCurrentDateFunction, SqlDatePartFunction, SqlExtractFunction, SqlGroupedWindowFunction, SqlJdbcFunctionCall, SqlJsonArrayFunction, SqlJsonDepthFunction, SqlJsonExistsFunction, SqlJsonKeysFunction, SqlJsonLengthFunction, SqlJsonModifyFunction, SqlJsonObjectFunction, SqlJsonPrettyFunction, SqlJsonQueryFunction, SqlJsonRemoveFunction, SqlJsonStorageSizeFunction, SqlJsonTypeFunction, SqlJsonValueFunction, SqlMatchFunction, SqlMonotonicUnaryFunction, SqlNullifFunction, SqlOverlayFunction, SqlPositionFunction, SqlRandIntegerFunction, SqlSubstringFunction, SqlTimestampAddFunction, SqlTranslate3Function, SqlTrimFunction, SqlTypeConstructorFunction, SqlUnresolvedFunction, SqlUserDefinedFunction, SqlUserDefinedTableMacro, SqlWindowTableFunction

public class SqlFunction
extends SqlOperator

A SqlFunction is a type of operator which has conventional function-call syntax.

Field Summary

Fields inherited from class org.apache.calcite.sql.SqlOperator

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SqlFunction(String name, @Nullable SqlIdentifier sqlIdentifier, SqlKind kind, @Nullable SqlReturnTypeInference returnTypeInference, @Nullable SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, @Nullable List<RelDataType> paramTypes, SqlFunctionCategory category)	Deprecated.
protected	SqlFunction(String name, @Nullable SqlIdentifier sqlIdentifier, SqlKind kind, @Nullable SqlReturnTypeInference returnTypeInference, @Nullable SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, SqlFunctionCategory category)	Internal constructor.
	SqlFunction(String name, SqlKind kind, @Nullable SqlReturnTypeInference returnTypeInference, @Nullable SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, SqlFunctionCategory category)	Creates a new SqlFunction for a call to a built-in function.
	SqlFunction(SqlIdentifier sqlIdentifier, @Nullable SqlReturnTypeInference returnTypeInference, @Nullable SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, @Nullable List<RelDataType> paramTypes, SqlFunctionCategory funcType)	Creates a placeholder SqlFunction for an invocation of a function with a possibly qualified name.

Method Summary

Modifier and Type	Method	Description
RelDataType	deriveType(SqlValidator validator, SqlValidatorScope scope, SqlCall call)	Derives the type of a call to this operator.
SqlFunctionCategory	getFunctionType()	Return function category.
SqlIdentifier	getNameAsId()	Returns the fully-qualified name of this operator.
List<String>	getParamNames()	Deprecated.
@Nullable List<RelDataType>	getParamTypes()	Deprecated.
@Nullable SqlIdentifier	getSqlIdentifier()	Returns the fully-qualified name of function, or null for a built-in function.
SqlSyntax	getSyntax()	Returns the syntactic type of this operator, never null.
boolean	isQuantifierAllowed()	Returns whether this function allows a DISTINCT or ALL quantifier.
void	unparse(SqlWriter writer, SqlCall call, int leftPrec, int rightPrec)	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.
void	validateCall(SqlCall call, SqlValidator validator, SqlValidatorScope scope, SqlValidatorScope operandScope)	Validates a call to this operator.
protected void	validateQuantifier(SqlValidator validator, SqlCall call)	Throws a validation error if a DISTINCT or ALL quantifier is present but not allowed.

Methods inherited from class org.apache.calcite.sql.SqlOperator

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, checkOperandTypes, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, createCall, createCall, createCall, deriveOperandType, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getSqlCallFactory, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SqlFunction

public SqlFunction(String name,
 SqlKind kind,
 @Nullable SqlReturnTypeInference returnTypeInference,
 @Nullable SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandTypeChecker operandTypeChecker,
 SqlFunctionCategory category)

Creates a new SqlFunction for a call to a built-in function.

Parameters:

name - Name of built-in function

kind - kind of operator implemented by function

returnTypeInference - strategy to use for return type inference

operandTypeInference - strategy to use for parameter type inference

operandTypeChecker - strategy to use for parameter type checking

category - categorization for function

SqlFunction

public SqlFunction(SqlIdentifier sqlIdentifier,
 @Nullable SqlReturnTypeInference returnTypeInference,
 @Nullable SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandTypeChecker operandTypeChecker,
 @Nullable List<RelDataType> paramTypes,
 SqlFunctionCategory funcType)

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.

Parameters:

sqlIdentifier - possibly qualified identifier for function

returnTypeInference - strategy to use for return type inference

operandTypeInference - strategy to use for parameter type inference

operandTypeChecker - strategy to use for parameter type checking

paramTypes - array of parameter types

funcType - function category

SqlFunction

@Deprecated
protected SqlFunction(String name,
 @Nullable SqlIdentifier sqlIdentifier,
 SqlKind kind,
 @Nullable SqlReturnTypeInference returnTypeInference,
 @Nullable SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandTypeChecker operandTypeChecker,
 @Nullable List<RelDataType> paramTypes,
 SqlFunctionCategory category)

Deprecated.

SqlFunction

protected SqlFunction(String name,
 @Nullable SqlIdentifier sqlIdentifier,
 SqlKind kind,
 @Nullable SqlReturnTypeInference returnTypeInference,
 @Nullable SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandTypeChecker operandTypeChecker,
 SqlFunctionCategory category)

Internal constructor.

Method Details

getSyntax

public SqlSyntax getSyntax()

Description copied from class: SqlOperator

Returns the syntactic type of this operator, never null.

Specified by:

getSyntax in class SqlOperator

getSqlIdentifier

public @Nullable SqlIdentifier getSqlIdentifier()

Returns the fully-qualified name of function, or null for a built-in function.

getNameAsId

public SqlIdentifier getNameAsId()

Description copied from class: SqlOperator

Returns the fully-qualified name of this operator.

Overrides:

getNameAsId in class SqlOperator

getParamTypes

@Deprecated
public @Nullable List<RelDataType> getParamTypes()

Deprecated.

Use SqlOperandMetadata.paramTypes(RelDataTypeFactory) on the result of SqlOperator.getOperandTypeChecker().

getParamNames

@Deprecated
public List<String> getParamNames()

Deprecated.

Use SqlOperandMetadata.paramNames() on the result of SqlOperator.getOperandTypeChecker().

unparse

public void unparse(SqlWriter writer,
 SqlCall call,
 int leftPrec,
 int rightPrec)

Description copied from class: SqlOperator

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.

The default implementation of this method delegates to SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int).

Overrides:

unparse in class SqlOperator

getFunctionType

public SqlFunctionCategory getFunctionType()

Return function category.

isQuantifierAllowed

@Pure
public boolean isQuantifierAllowed()

Returns whether this function allows a DISTINCT or ALL quantifier. The default is false; some aggregate functions return true.

validateCall

public void validateCall(SqlCall call,
 SqlValidator validator,
 SqlValidatorScope scope,
 SqlValidatorScope operandScope)

Description copied from class: SqlOperator

Validates a call to this operator.

This method should not perform type-derivation or perform validation related related to types. That is done later, by SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall). This method should focus on structural validation.

A typical implementation of this method first validates the operands, then performs some operator-specific logic. The default implementation just validates the operands.

This method is the default implementation of SqlCall.validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope); but note that some sub-classes of SqlCall never call this method.

Overrides:

validateCall in class SqlOperator

Parameters:

call - the call to this operator

validator - the active validator

scope - validator scope

operandScope - validator scope in which to validate operands to this call; usually equal to scope, but not always because some operators introduce new scopes

See Also:

• SqlNode.validateExpr(SqlValidator, SqlValidatorScope)
• SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall)

validateQuantifier

protected void validateQuantifier(SqlValidator validator,
 SqlCall call)

Throws a validation error if a DISTINCT or ALL quantifier is present but not allowed.

deriveType

public RelDataType deriveType(SqlValidator validator,
 SqlValidatorScope scope,
 SqlCall call)

Description copied from class: SqlOperator

Derives the type of a call to this operator.

This method is an intrinsic part of the validation process so, unlike SqlOperator.inferReturnType(org.apache.calcite.sql.SqlOperatorBinding), specific operators would not typically override this method.

Overrides:

deriveType in class SqlOperator

Parameters:

validator - Validator

scope - Scope of validation

call - Call to this operator

Returns:

Type of call