Package org.apache.calcite.sql.validate

Class SqlUserDefinedFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.validate.SqlUserDefinedFunction

Direct Known Subclasses:

PigUserDefinedFunction, SqlUserDefinedTableFunction

public class SqlUserDefinedFunction
extends SqlFunction

User-defined scalar function.

Created by the validator, after resolving a function call to a function defined in a Calcite schema.

Field Summary

Fields

Modifier and Type	Field	Description
final Function	function
final SqlSyntax	syntax

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqlUserDefinedFunction(SqlIdentifier opName, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandMetadata operandMetadata, Function function)	Creates a SqlUserDefinedFunction.
protected	SqlUserDefinedFunction(SqlIdentifier opName, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandMetadata operandMetadata, Function function, SqlFunctionCategory category, SqlSyntax syntax)	Constructor used internally and by derived classes.
	SqlUserDefinedFunction(SqlIdentifier opName, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandMetadata operandMetadata, Function function, SqlSyntax syntax)	Creates a SqlUserDefinedFunction with sql syntax.
	SqlUserDefinedFunction(SqlIdentifier opName, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, List<RelDataType> paramTypes, Function function)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Function	getFunction()	Returns function that implements given operator call.
@Nullable SqlOperandMetadata	getOperandTypeChecker()
List<String>	getParamNames()	Use SqlOperandMetadata.paramNames() on the result of SqlOperator.getOperandTypeChecker().
SqlSyntax	getSyntax()	Returns the syntactic type of this operator, never null.

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

deriveType, getFunctionType, getNameAsId, getParamTypes, getSqlIdentifier, isQuantifierAllowed, unparse, validateCall, 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, getMonotonicity, getName, getOperandCountRange, 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

Field Details

function

public final Function function

syntax

public final SqlSyntax syntax

Constructor Details

SqlUserDefinedFunction

@Deprecated
public SqlUserDefinedFunction(SqlIdentifier opName,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandTypeChecker operandTypeChecker,
 List<RelDataType> paramTypes,
 Function function)

Deprecated.

SqlUserDefinedFunction

public SqlUserDefinedFunction(SqlIdentifier opName,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandMetadata operandMetadata,
 Function function)

Creates a SqlUserDefinedFunction.

SqlUserDefinedFunction

public SqlUserDefinedFunction(SqlIdentifier opName,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandMetadata operandMetadata,
 Function function,
 SqlSyntax syntax)

Creates a SqlUserDefinedFunction with sql syntax.

SqlUserDefinedFunction

protected SqlUserDefinedFunction(SqlIdentifier opName,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlOperandTypeInference operandTypeInference,
 @Nullable SqlOperandMetadata operandMetadata,
 Function function,
 SqlFunctionCategory category,
 SqlSyntax syntax)

Constructor used internally and by derived classes.

Method Details

getOperandTypeChecker

public @Nullable SqlOperandMetadata 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

getFunction

public Function getFunction()

Returns function that implements given operator call.

Returns:

function that implements given operator call

getParamNames

public List<String> getParamNames()

Description copied from class: SqlFunction

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

Overrides:

getParamNames in class SqlFunction