Package io.trino.metadata

Class FunctionMetadata

java.lang.Object

io.trino.metadata.FunctionMetadata

public class FunctionMetadata
extends Object

Constructor Summary

Constructors

Constructor	Description
FunctionMetadata(FunctionId functionId, Signature signature, String actualName, boolean nullable, List<FunctionArgumentDefinition> argumentDefinitions, boolean hidden, boolean deterministic, String description, FunctionKind kind, boolean deprecated)
FunctionMetadata(Signature signature, boolean nullable, List<FunctionArgumentDefinition> argumentDefinitions, boolean hidden, boolean deterministic, String description, FunctionKind kind)
FunctionMetadata(Signature signature, String actualName, boolean nullable, List<FunctionArgumentDefinition> argumentDefinitions, boolean hidden, boolean deterministic, String description, FunctionKind kind, boolean deprecated)

Method Summary

Modifier and Type	Method	Description
String	getActualName()	Returns the name under which function is registered.
List<FunctionArgumentDefinition>	getArgumentDefinitions()
String	getDescription()
FunctionId	getFunctionId()	Returns FunctionId under which function is to be registered.
FunctionKind	getKind()
Signature	getSignature()	Returns function Signature with canonical name of the function.
boolean	isDeprecated()
boolean	isDeterministic()
boolean	isHidden()
boolean	isNullable()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionMetadata

public FunctionMetadata(Signature signature,
                        boolean nullable,
                        List<FunctionArgumentDefinition> argumentDefinitions,
                        boolean hidden,
                        boolean deterministic,
                        String description,
                        FunctionKind kind)

FunctionMetadata

public FunctionMetadata(Signature signature,
                        String actualName,
                        boolean nullable,
                        List<FunctionArgumentDefinition> argumentDefinitions,
                        boolean hidden,
                        boolean deterministic,
                        String description,
                        FunctionKind kind,
                        boolean deprecated)

FunctionMetadata

public FunctionMetadata(FunctionId functionId,
                        Signature signature,
                        String actualName,
                        boolean nullable,
                        List<FunctionArgumentDefinition> argumentDefinitions,
                        boolean hidden,
                        boolean deterministic,
                        String description,
                        FunctionKind kind,
                        boolean deprecated)

Method Detail

getFunctionId

public FunctionId getFunctionId()

Returns FunctionId under which function is to be registered. It is based on the getActualName(), which is either the canonical function name or an alias.

getSignature

public Signature getSignature()

Returns function Signature with canonical name of the function.

getActualName

public String getActualName()

Returns the name under which function is registered. Typically same as getSignature().getName() unless this is an alias.

isNullable

public boolean isNullable()

getArgumentDefinitions

public List<FunctionArgumentDefinition> getArgumentDefinitions()

isHidden

public boolean isHidden()

isDeterministic

public boolean isDeterministic()

getDescription

public String getDescription()

getKind

public FunctionKind getKind()

isDeprecated

public boolean isDeprecated()

toString

public String toString()

Overrides:

toString in class Object