org.apache.calcite.sql

Class SqlFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

Direct Known Subclasses:

CalciteSqlFunction, ProctimeMaterializeSqlFunction, org.apache.flink.table.planner.functions.utils.ScalarSqlFunction, org.apache.calcite.sql.SqlAggFunction, SqlThrowExceptionFunction, org.apache.calcite.sql.validate.SqlUserDefinedFunction, StreamRecordTimestampSqlFunction

public class SqlFunction
extends org.apache.calcite.sql.SqlOperator

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

This file is copied from Apache Calcite and should be removed once CALCITE-3360 has been fixed. Changed lines: 279-293

Field Summary

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Modifier	Constructor and Description
	SqlFunction(org.apache.calcite.sql.SqlIdentifier sqlIdentifier, org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker, List<org.apache.calcite.rel.type.RelDataType> paramTypes, org.apache.calcite.sql.SqlFunctionCategory funcType) Creates a placeholder SqlFunction for an invocation of a function with a possibly qualified name.
protected	SqlFunction(String name, org.apache.calcite.sql.SqlIdentifier sqlIdentifier, org.apache.calcite.sql.SqlKind kind, org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker, List<org.apache.calcite.rel.type.RelDataType> paramTypes, org.apache.calcite.sql.SqlFunctionCategory category) Internal constructor.
	SqlFunction(String name, org.apache.calcite.sql.SqlKind kind, org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker, org.apache.calcite.sql.SqlFunctionCategory category) Creates a new SqlFunction for a call to a builtin function.

Method Summary

Modifier and Type	Method and Description
org.apache.calcite.rel.type.RelDataType	deriveType(org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.sql.validate.SqlValidatorScope scope, org.apache.calcite.sql.SqlCall call)
org.apache.calcite.sql.SqlFunctionCategory	getFunctionType()
org.apache.calcite.sql.SqlIdentifier	getNameAsId()
List<String>	getParamNames() Returns a list of parameter names.
List<org.apache.calcite.rel.type.RelDataType>	getParamTypes()
org.apache.calcite.sql.SqlIdentifier	getSqlIdentifier()
org.apache.calcite.sql.SqlSyntax	getSyntax()
boolean	isQuantifierAllowed() Returns whether this function allows a DISTINCT or ALL quantifier.
void	unparse(org.apache.calcite.sql.SqlWriter writer, org.apache.calcite.sql.SqlCall call, int leftPrec, int rightPrec)
void	validateCall(org.apache.calcite.sql.SqlCall call, org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.sql.validate.SqlValidatorScope scope, org.apache.calcite.sql.validate.SqlValidatorScope operandScope)
protected void	validateQuantifier(org.apache.calcite.sql.validate.SqlValidator validator, org.apache.calcite.sql.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, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, leftPrec, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlFunction

public SqlFunction(String name,
                   org.apache.calcite.sql.SqlKind kind,
                   org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference,
                   org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference,
                   org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker,
                   org.apache.calcite.sql.SqlFunctionCategory category)

Creates a new SqlFunction for a call to a builtin function.

Parameters:

name - Name of builtin 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(org.apache.calcite.sql.SqlIdentifier sqlIdentifier,
                   org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference,
                   org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference,
                   org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker,
                   List<org.apache.calcite.rel.type.RelDataType> paramTypes,
                   org.apache.calcite.sql.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 builtin 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

protected SqlFunction(String name,
                      org.apache.calcite.sql.SqlIdentifier sqlIdentifier,
                      org.apache.calcite.sql.SqlKind kind,
                      org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference,
                      org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference,
                      org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker,
                      List<org.apache.calcite.rel.type.RelDataType> paramTypes,
                      org.apache.calcite.sql.SqlFunctionCategory category)

Internal constructor.

Method Detail

getSyntax

public org.apache.calcite.sql.SqlSyntax getSyntax()

Specified by:

getSyntax in class org.apache.calcite.sql.SqlOperator

getSqlIdentifier

public org.apache.calcite.sql.SqlIdentifier getSqlIdentifier()

Returns:

fully qualified name of function, or null for a builtin function

getNameAsId

public org.apache.calcite.sql.SqlIdentifier getNameAsId()

Overrides:

getNameAsId in class org.apache.calcite.sql.SqlOperator

getParamTypes

public List<org.apache.calcite.rel.type.RelDataType> getParamTypes()

Returns:

array of parameter types, or null for builtin function

getParamNames

public List<String> getParamNames()

Returns a list of parameter names.

The default implementation returns [arg0, arg1, ..., argN].

unparse

public void unparse(org.apache.calcite.sql.SqlWriter writer,
                    org.apache.calcite.sql.SqlCall call,
                    int leftPrec,
                    int rightPrec)

Overrides:

unparse in class org.apache.calcite.sql.SqlOperator

getFunctionType

@Nonnull
public org.apache.calcite.sql.SqlFunctionCategory getFunctionType()

Returns:

function category

isQuantifierAllowed

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(org.apache.calcite.sql.SqlCall call,
                         org.apache.calcite.sql.validate.SqlValidator validator,
                         org.apache.calcite.sql.validate.SqlValidatorScope scope,
                         org.apache.calcite.sql.validate.SqlValidatorScope operandScope)

Overrides:

validateCall in class org.apache.calcite.sql.SqlOperator

validateQuantifier

protected void validateQuantifier(org.apache.calcite.sql.validate.SqlValidator validator,
                                  org.apache.calcite.sql.SqlCall call)

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

deriveType

public org.apache.calcite.rel.type.RelDataType deriveType(org.apache.calcite.sql.validate.SqlValidator validator,
                                                          org.apache.calcite.sql.validate.SqlValidatorScope scope,
                                                          org.apache.calcite.sql.SqlCall call)

Overrides:

deriveType in class org.apache.calcite.sql.SqlOperator