Package org.apache.calcite.sql

Class SqlBasicFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlBasicFunction

public final class SqlBasicFunction
extends SqlFunction

Concrete implementation of SqlFunction.

The class is final, and instances are immutable.

Instances are created only by create(java.lang.String, org.apache.calcite.sql.SqlKind, org.apache.calcite.sql.type.SqlReturnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker) and are "modified" by "wither" methods such as withName(java.lang.String) to create a new instance with one property changed. Since the class is final, you can modify behavior only by providing strategy objects, not by overriding methods in a subclass.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Method Summary

Modifier and Type	Method	Description
static SqlBasicFunction	create(String name, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker)	Creates a SqlBasicFunction.
static SqlBasicFunction	create(String name, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker)	Creates a SqlBasicFunction with kind SqlKind.OTHER_FUNCTION and category SqlFunctionCategory.NUMERIC.
static SqlBasicFunction	create(String name, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker, SqlFunctionCategory category)	Creates a SqlBasicFunction with kind SqlKind.OTHER_FUNCTION.
static SqlBasicFunction	create(SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker)	Creates a SqlBasicFunction whose name is the same as its kind and whose category SqlFunctionCategory.SYSTEM.
SqlMonotonicity	getMonotonicity(SqlOperatorBinding call)	Returns whether a call to this operator is monotonic.
SqlOperandTypeChecker	getOperandTypeChecker()
SqlReturnTypeInference	getReturnTypeInference()	Returns the return type inference strategy for this operator, or null if return type inference is implemented by a subclass override.
SqlSyntax	getSyntax()	Returns the syntactic type of this operator, never null.
boolean	isDeterministic()	Returns whether a call to this operator is guaranteed to always return the same result given the same operands; true is assumed by default.
boolean	isDynamicFunction()	Returns whether it is unsafe to cache query plans referencing this operator; false is assumed by default.
@Nullable SqlOperator	reverse()	Returns the operator that has the same effect as this operator if its arguments are reversed.
SqlNode	rewriteCall(SqlValidator validator, SqlCall call)	Rewrites a call to this operator.
void	validateCall(SqlCall call, SqlValidator validator, SqlValidatorScope scope, SqlValidatorScope operandScope)	Validates a call to this operator.
SqlBasicFunction	withDeterministic(boolean deterministic)	Returns a copy of this function with a given determinism.
SqlBasicFunction	withDynamic(boolean dynamic)
SqlBasicFunction	withFunctionType(SqlFunctionCategory category)	Returns a copy of this function with a given category.
SqlBasicFunction	withKind(SqlKind kind)	Returns a copy of this function with a given kind.
SqlBasicFunction	withMonotonicityInference(Function<SqlOperatorBinding,SqlMonotonicity> monotonicityInference)	Returns a copy of this function with a given strategy for inferring whether a call is monotonic.
SqlBasicFunction	withName(String name)	Returns a copy of this function with a given name.
SqlBasicFunction	withOperandHandler(SqlOperandHandler operandHandler)	Returns a copy of this function with a given strategy for handling operands.
SqlBasicFunction	withOperandTypeChecker(SqlOperandTypeChecker operandTypeChecker)
SqlBasicFunction	withOperandTypeInference(SqlOperandTypeInference operandTypeInference)	Returns a copy of this function with a given strategy for inferring the types of its operands.
SqlBasicFunction	withReturnTypeInference(SqlReturnTypeInference returnTypeInference)	Returns a copy of this function with a given strategy for inferring returned type.
SqlBasicFunction	withSyntax(SqlSyntax syntax)	Returns a copy of this function with a given syntax.
SqlBasicFunction	withValidation(int callValidator)

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

deriveType, getFunctionType, getNameAsId, getParamNames, getParamTypes, getSqlIdentifier, isQuantifierAllowed, unparse, validateQuantifier

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, getName, getOperandCountRange, getOperandTypeInference, getRightPrec, getSignatureTemplate, getSqlCallFactory, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isAggregator, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Method Details

create

public static SqlBasicFunction create(String name,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeChecker operandTypeChecker)

Creates a SqlBasicFunction.

Parameters:

name - function name

kind - function kind

returnTypeInference - Strategy to use for return type inference

operandTypeChecker - Strategy to use for parameter type checking

Returns:

a SqlBasicFunction

create

public static SqlBasicFunction create(SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeChecker operandTypeChecker)

Creates a SqlBasicFunction whose name is the same as its kind and whose category SqlFunctionCategory.SYSTEM.

create

public static SqlBasicFunction create(String name,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeChecker operandTypeChecker)

Creates a SqlBasicFunction with kind SqlKind.OTHER_FUNCTION and category SqlFunctionCategory.NUMERIC.

create

public static SqlBasicFunction create(String name,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeChecker operandTypeChecker,
 SqlFunctionCategory category)

Creates a SqlBasicFunction with kind SqlKind.OTHER_FUNCTION.

getReturnTypeInference

public SqlReturnTypeInference getReturnTypeInference()

Description copied from class: SqlOperator

Returns the return type inference strategy for this operator, or null if return type inference is implemented by a subclass override.

Overrides:

getReturnTypeInference in class SqlOperator

getOperandTypeChecker

public SqlOperandTypeChecker getOperandTypeChecker()

Overrides:

getOperandTypeChecker in class SqlOperator

getSyntax

public SqlSyntax getSyntax()

Description copied from class: SqlOperator

Returns the syntactic type of this operator, never null.

Overrides:

getSyntax in class SqlFunction

isDeterministic

public boolean isDeterministic()

Description copied from class: SqlOperator

Returns whether a call to this operator is guaranteed to always return the same result given the same operands; true is assumed by default.

Overrides:

isDeterministic in class SqlOperator

reverse

public @Nullable SqlOperator reverse()

Description copied from class: SqlOperator

Returns the operator that has the same effect as this operator if its arguments are reversed.

For example, SqlStdOperatorTable.GREATER_THAN.reverse() returns SqlStdOperatorTable.LESS_THAN, and vice versa, because a > b is equivalent to b < a.

SqlStdOperatorTable.EQUALS.reverse() returns itself.

By default, returns null, which means there is no inverse operator.

Overrides:

reverse in class SqlOperator

See Also:

• SqlOperator.not()
• SqlKind.reverse()

getMonotonicity

public SqlMonotonicity getMonotonicity(SqlOperatorBinding call)

Description copied from class: SqlOperator

Returns whether a call to this operator is monotonic.

Default implementation returns SqlMonotonicity.NOT_MONOTONIC.

Overrides:

getMonotonicity in class SqlOperator

Parameters:

call - Call to this operator with particular arguments and information about the monotonicity of the arguments

rewriteCall

public SqlNode rewriteCall(SqlValidator validator,
 SqlCall call)

Description copied from class: SqlOperator

Rewrites a call to this operator. Some operators are implemented as trivial rewrites (e.g. NULLIF becomes CASE). However, we don't do this at createCall time because we want to preserve the original SQL syntax as much as possible; instead, we do this before the call is validated (so the trivial operator doesn't need its own implementation of type derivation methods). The default implementation is to just return the original call without any rewrite.

Overrides:

rewriteCall in class SqlOperator

Parameters:

validator - Validator

call - Call to be rewritten

Returns:

rewritten call

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 SqlFunction

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)

isDynamicFunction

public boolean isDynamicFunction()

Description copied from class: SqlOperator

Returns whether it is unsafe to cache query plans referencing this operator; false is assumed by default.

Overrides:

isDynamicFunction in class SqlOperator

withName

public SqlBasicFunction withName(String name)

Returns a copy of this function with a given name.

withKind

public SqlBasicFunction withKind(SqlKind kind)

Returns a copy of this function with a given kind.

withFunctionType

public SqlBasicFunction withFunctionType(SqlFunctionCategory category)

Returns a copy of this function with a given category.

withSyntax

public SqlBasicFunction withSyntax(SqlSyntax syntax)

Returns a copy of this function with a given syntax.

withReturnTypeInference

public SqlBasicFunction withReturnTypeInference(SqlReturnTypeInference returnTypeInference)

Returns a copy of this function with a given strategy for inferring returned type.

withOperandTypeInference

public SqlBasicFunction withOperandTypeInference(SqlOperandTypeInference operandTypeInference)

Returns a copy of this function with a given strategy for inferring the types of its operands.

withOperandHandler

public SqlBasicFunction withOperandHandler(SqlOperandHandler operandHandler)

Returns a copy of this function with a given strategy for handling operands.

withDeterministic

public SqlBasicFunction withDeterministic(boolean deterministic)

Returns a copy of this function with a given determinism.

withMonotonicityInference

public SqlBasicFunction withMonotonicityInference(Function<SqlOperatorBinding,SqlMonotonicity> monotonicityInference)

Returns a copy of this function with a given strategy for inferring whether a call is monotonic.

withValidation

public SqlBasicFunction withValidation(int callValidator)

withDynamic

public SqlBasicFunction withDynamic(boolean dynamic)

withOperandTypeChecker

public SqlBasicFunction withOperandTypeChecker(SqlOperandTypeChecker operandTypeChecker)