public interface FunctionParameter
Function
.
NOTE: We'd have called it Parameter
but the overlap with
Parameter
was too confusing.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Name of the parameter.
|
int |
getOrdinal()
Zero-based ordinal of this parameter within the member's parameter
list.
|
RelDataType |
getType(RelDataTypeFactory typeFactory)
Returns the type of this parameter.
|
boolean |
isOptional()
Returns whether this parameter is optional.
|
int getOrdinal()
java.lang.String getName()
RelDataType getType(RelDataTypeFactory typeFactory)
typeFactory
- Type factory to be used to create the typeboolean isOptional()
If true, the value of the parameter can be supplied using the DEFAULT SQL keyword, or it can be omitted from a function called using argument assignment, or the function can be called with fewer parameters (if all parameters after it are optional too).
If a parameter is optional its default value is NULL. We may in future allow functions to specify other default values.
Copyright © 2012–2019 The Apache Software Foundation. All rights reserved.