org.apache.flink.table.planner.functions.bridging

Class BridgingSqlFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.flink.table.planner.functions.bridging.BridgingSqlFunction

Direct Known Subclasses:

BridgingSqlFunction.WithTableFunction

@Internal
public class BridgingSqlFunction
extends org.apache.calcite.sql.SqlFunction

Bridges FunctionDefinition to Calcite's representation of a scalar or table function (either a system or user-defined function).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BridgingSqlFunction.WithTableFunction Special flavor of BridgingSqlFunction to indicate a table function to Calcite.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Method Summary

Modifier and Type	Method and Description
org.apache.flink.table.catalog.DataTypeFactory	getDataTypeFactory()
org.apache.flink.table.functions.FunctionDefinition	getDefinition()
List<String>	getParamNames()
org.apache.flink.table.catalog.ContextResolvedFunction	getResolvedFunction()
org.apache.flink.table.planner.calcite.FlinkTypeFactory	getTypeFactory()
org.apache.flink.table.types.inference.TypeInference	getTypeInference()
boolean	isDeterministic()
static BridgingSqlFunction	of(org.apache.flink.table.catalog.DataTypeFactory dataTypeFactory, org.apache.flink.table.planner.calcite.FlinkTypeFactory typeFactory, org.apache.calcite.sql.SqlKind kind, org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction, org.apache.flink.table.types.inference.TypeInference typeInference) Creates an instance of a scalar or table function (either a system or user-defined function).
static BridgingSqlFunction	of(org.apache.flink.table.planner.calcite.FlinkContext context, org.apache.flink.table.planner.calcite.FlinkTypeFactory typeFactory, org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction) Creates an instance of a scalar or table function during translation.
static BridgingSqlFunction	of(org.apache.calcite.plan.RelOptCluster cluster, org.apache.flink.table.functions.BuiltInFunctionDefinition functionDefinition) Creates an instance of a scalar or table built-in function during translation.
static BridgingSqlFunction	of(org.apache.calcite.plan.RelOptCluster cluster, org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction) Creates an instance of a scalar or table function during translation.

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

deriveType, getFunctionType, getNameAsId, getParamTypes, getSqlIdentifier, getSyntax, 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, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isAggregator, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, 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

Method Detail

of

public static BridgingSqlFunction of(org.apache.flink.table.catalog.DataTypeFactory dataTypeFactory,
                                     org.apache.flink.table.planner.calcite.FlinkTypeFactory typeFactory,
                                     org.apache.calcite.sql.SqlKind kind,
                                     org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction,
                                     org.apache.flink.table.types.inference.TypeInference typeInference)

Creates an instance of a scalar or table function (either a system or user-defined function).

Parameters:

dataTypeFactory - used for creating DataType

typeFactory - used for bridging to RelDataType

kind - commonly used SQL standard function; use SqlKind.OTHER_FUNCTION if this function cannot be mapped to a common function kind.

resolvedFunction - system or user-defined FunctionDefinition with context

typeInference - type inference logic

of

public static BridgingSqlFunction of(org.apache.flink.table.planner.calcite.FlinkContext context,
                                     org.apache.flink.table.planner.calcite.FlinkTypeFactory typeFactory,
                                     org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction)

Creates an instance of a scalar or table function during translation.

of

public static BridgingSqlFunction of(org.apache.calcite.plan.RelOptCluster cluster,
                                     org.apache.flink.table.catalog.ContextResolvedFunction resolvedFunction)

Creates an instance of a scalar or table function during translation.

of

public static BridgingSqlFunction of(org.apache.calcite.plan.RelOptCluster cluster,
                                     org.apache.flink.table.functions.BuiltInFunctionDefinition functionDefinition)

Creates an instance of a scalar or table built-in function during translation.

getDataTypeFactory

public org.apache.flink.table.catalog.DataTypeFactory getDataTypeFactory()

getTypeFactory

public org.apache.flink.table.planner.calcite.FlinkTypeFactory getTypeFactory()

getResolvedFunction

public org.apache.flink.table.catalog.ContextResolvedFunction getResolvedFunction()

getDefinition

public org.apache.flink.table.functions.FunctionDefinition getDefinition()

getTypeInference

public org.apache.flink.table.types.inference.TypeInference getTypeInference()

getParamNames

public List<String> getParamNames()

Overrides:

getParamNames in class org.apache.calcite.sql.SqlFunction

isDeterministic

public boolean isDeterministic()

Overrides:

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