@Internal public final class BuiltInFunctionDefinition extends Object implements FunctionDefinition
Compared to regular FunctionDefinition
, built-in functions have a default name. This
default name is used to lookup the function in a catalog during resolution.
Equality is defined by reference equality.
Modifier and Type | Class and Description |
---|---|
static class |
BuiltInFunctionDefinition.Builder
Builder for fluent definition of built-in functions.
|
Modifier and Type | Method and Description |
---|---|
FunctionKind |
getKind()
Returns the kind of function this definition describes.
|
String |
getName() |
TypeInference |
getTypeInference(DataTypeFactory typeFactory)
Returns the logic for performing type inference of a call to this function definition.
|
static BuiltInFunctionDefinition.Builder |
newBuilder()
Builder for configuring and creating instances of
BuiltInFunctionDefinition . |
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getRequirements, isDeterministic
public static BuiltInFunctionDefinition.Builder newBuilder()
BuiltInFunctionDefinition
.public String getName()
public FunctionKind getKind()
FunctionDefinition
getKind
in interface FunctionDefinition
public TypeInference getTypeInference(DataTypeFactory typeFactory)
FunctionDefinition
The type inference process is responsible for inferring unknown types of input arguments, validating input arguments, and producing result types. The type inference process happens independent of a function body. The output of the type inference is used to search for a corresponding runtime implementation.
Instances of type inference can be created by using TypeInference.newBuilder()
.
See BuiltInFunctionDefinitions
for concrete usage examples.
getTypeInference
in interface FunctionDefinition
Copyright © 2014–2021 The Apache Software Foundation. All rights reserved.